2 * linux/drivers/mmc/core/sdio_io.c
4 * Copyright 2007-2008 Pierre Ossman
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or (at
9 * your option) any later version.
12 #include <linux/export.h>
13 #include <linux/mmc/host.h>
14 #include <linux/mmc/card.h>
15 #include <linux/mmc/sdio.h>
16 #include <linux/mmc/sdio_func.h>
21 * sdio_claim_host - exclusively claim a bus for a certain SDIO function
22 * @func: SDIO function that will be accessed
24 * Claim a bus for a set of operations. The SDIO function given
25 * is used to figure out which bus is relevant.
27 void sdio_claim_host(struct sdio_func *func)
32 mmc_claim_host(func->card->host);
34 EXPORT_SYMBOL_GPL(sdio_claim_host);
37 * sdio_release_host - release a bus for a certain SDIO function
38 * @func: SDIO function that was accessed
40 * Release a bus, allowing others to claim the bus for their
43 void sdio_release_host(struct sdio_func *func)
48 mmc_release_host(func->card->host);
50 EXPORT_SYMBOL_GPL(sdio_release_host);
53 * sdio_enable_func - enables a SDIO function for usage
54 * @func: SDIO function to enable
56 * Powers up and activates a SDIO function so that register
59 int sdio_enable_func(struct sdio_func *func)
63 unsigned long timeout;
68 pr_debug("SDIO: Enabling device %s...\n", sdio_func_id(func));
70 ret = mmc_io_rw_direct(func->card, 0, 0, SDIO_CCCR_IOEx, 0, ®);
74 reg |= 1 << func->num;
76 ret = mmc_io_rw_direct(func->card, 1, 0, SDIO_CCCR_IOEx, reg, NULL);
80 timeout = jiffies + msecs_to_jiffies(func->enable_timeout);
83 ret = mmc_io_rw_direct(func->card, 0, 0, SDIO_CCCR_IORx, 0, ®);
86 if (reg & (1 << func->num))
89 if (time_after(jiffies, timeout))
93 pr_debug("SDIO: Enabled device %s\n", sdio_func_id(func));
98 pr_debug("SDIO: Failed to enable device %s\n", sdio_func_id(func));
101 EXPORT_SYMBOL_GPL(sdio_enable_func);
104 * sdio_disable_func - disable a SDIO function
105 * @func: SDIO function to disable
107 * Powers down and deactivates a SDIO function. Register access
108 * to this function will fail until the function is reenabled.
110 int sdio_disable_func(struct sdio_func *func)
118 pr_debug("SDIO: Disabling device %s...\n", sdio_func_id(func));
120 ret = mmc_io_rw_direct(func->card, 0, 0, SDIO_CCCR_IOEx, 0, ®);
124 reg &= ~(1 << func->num);
126 ret = mmc_io_rw_direct(func->card, 1, 0, SDIO_CCCR_IOEx, reg, NULL);
130 pr_debug("SDIO: Disabled device %s\n", sdio_func_id(func));
135 pr_debug("SDIO: Failed to disable device %s\n", sdio_func_id(func));
138 EXPORT_SYMBOL_GPL(sdio_disable_func);
141 * sdio_set_block_size - set the block size of an SDIO function
142 * @func: SDIO function to change
143 * @blksz: new block size or 0 to use the default.
145 * The default block size is the largest supported by both the function
146 * and the host, with a maximum of 512 to ensure that arbitrarily sized
147 * data transfer use the optimal (least) number of commands.
149 * A driver may call this to override the default block size set by the
150 * core. This can be used to set a block size greater than the maximum
151 * that reported by the card; it is the driver's responsibility to ensure
152 * it uses a value that the card supports.
154 * Returns 0 on success, -EINVAL if the host does not support the
155 * requested block size, or -EIO (etc.) if one of the resultant FBR block
156 * size register writes failed.
159 int sdio_set_block_size(struct sdio_func *func, unsigned blksz)
163 if (blksz > func->card->host->max_blk_size)
167 blksz = min(func->max_blksize, func->card->host->max_blk_size);
168 blksz = min(blksz, 512u);
171 ret = mmc_io_rw_direct(func->card, 1, 0,
172 SDIO_FBR_BASE(func->num) + SDIO_FBR_BLKSIZE,
176 ret = mmc_io_rw_direct(func->card, 1, 0,
177 SDIO_FBR_BASE(func->num) + SDIO_FBR_BLKSIZE + 1,
178 (blksz >> 8) & 0xff, NULL);
181 func->cur_blksize = blksz;
184 EXPORT_SYMBOL_GPL(sdio_set_block_size);
187 * Calculate the maximum byte mode transfer size
189 static inline unsigned int sdio_max_byte_size(struct sdio_func *func)
191 unsigned mval = min(func->card->host->max_seg_size,
192 func->card->host->max_blk_size);
194 if (mmc_blksz_for_byte_mode(func->card))
195 mval = min(mval, func->cur_blksize);
197 mval = min(mval, func->max_blksize);
199 if (mmc_card_broken_byte_mode_512(func->card))
200 return min(mval, 511u);
202 return min(mval, 512u); /* maximum size for byte mode */
206 * sdio_align_size - pads a transfer size to a more optimal value
207 * @func: SDIO function
208 * @sz: original transfer size
210 * Pads the original data size with a number of extra bytes in
211 * order to avoid controller bugs and/or performance hits
212 * (e.g. some controllers revert to PIO for certain sizes).
214 * If possible, it will also adjust the size so that it can be
215 * handled in just a single request.
217 * Returns the improved size, which might be unmodified.
219 unsigned int sdio_align_size(struct sdio_func *func, unsigned int sz)
221 unsigned int orig_sz;
222 unsigned int blk_sz, byte_sz;
228 * Do a first check with the controller, in case it
229 * wants to increase the size up to a point where it
230 * might need more than one block.
232 sz = mmc_align_data_size(func->card, sz);
235 * If we can still do this with just a byte transfer, then
238 if (sz <= sdio_max_byte_size(func))
241 if (func->card->cccr.multi_block) {
243 * Check if the transfer is already block aligned
245 if ((sz % func->cur_blksize) == 0)
249 * Realign it so that it can be done with one request,
250 * and recheck if the controller still likes it.
252 blk_sz = ((sz + func->cur_blksize - 1) /
253 func->cur_blksize) * func->cur_blksize;
254 blk_sz = mmc_align_data_size(func->card, blk_sz);
257 * This value is only good if it is still just
260 if ((blk_sz % func->cur_blksize) == 0)
264 * We failed to do one request, but at least try to
265 * pad the remainder properly.
267 byte_sz = mmc_align_data_size(func->card,
268 sz % func->cur_blksize);
269 if (byte_sz <= sdio_max_byte_size(func)) {
270 blk_sz = sz / func->cur_blksize;
271 return blk_sz * func->cur_blksize + byte_sz;
275 * We need multiple requests, so first check that the
276 * controller can handle the chunk size;
278 chunk_sz = mmc_align_data_size(func->card,
279 sdio_max_byte_size(func));
280 if (chunk_sz == sdio_max_byte_size(func)) {
282 * Fix up the size of the remainder (if any)
284 byte_sz = orig_sz % chunk_sz;
286 byte_sz = mmc_align_data_size(func->card,
290 return (orig_sz / chunk_sz) * chunk_sz + byte_sz;
295 * The controller is simply incapable of transferring the size
296 * we want in decent manner, so just return the original size.
300 EXPORT_SYMBOL_GPL(sdio_align_size);
302 /* Split an arbitrarily sized data transfer into several
303 * IO_RW_EXTENDED commands. */
304 static int sdio_io_rw_ext_helper(struct sdio_func *func, int write,
305 unsigned addr, int incr_addr, u8 *buf, unsigned size)
307 unsigned remainder = size;
311 /* Do the bulk of the transfer using block mode (if supported). */
312 if (func->card->cccr.multi_block && (size > sdio_max_byte_size(func))) {
313 /* Blocks per command is limited by host count, host transfer
314 * size (we only use a single sg entry) and the maximum for
315 * IO_RW_EXTENDED of 511 blocks. */
316 max_blocks = min(func->card->host->max_blk_count,
317 func->card->host->max_seg_size / func->cur_blksize);
318 max_blocks = min(max_blocks, 511u);
320 while (remainder >= func->cur_blksize) {
323 blocks = remainder / func->cur_blksize;
324 if (blocks > max_blocks)
326 size = blocks * func->cur_blksize;
328 ret = mmc_io_rw_extended(func->card, write,
329 func->num, addr, incr_addr, buf,
330 blocks, func->cur_blksize);
341 /* Write the remainder using byte mode. */
342 while (remainder > 0) {
343 size = min(remainder, sdio_max_byte_size(func));
345 /* Indicate byte mode by setting "blocks" = 0 */
346 ret = mmc_io_rw_extended(func->card, write, func->num, addr,
347 incr_addr, buf, 0, size);
360 * sdio_readb - read a single byte from a SDIO function
361 * @func: SDIO function to access
362 * @addr: address to read
363 * @err_ret: optional status value from transfer
365 * Reads a single byte from the address space of a given SDIO
366 * function. If there is a problem reading the address, 0xff
367 * is returned and @err_ret will contain the error code.
369 u8 sdio_readb(struct sdio_func *func, unsigned int addr, int *err_ret)
379 ret = mmc_io_rw_direct(func->card, 0, func->num, addr, 0, &val);
388 EXPORT_SYMBOL_GPL(sdio_readb);
391 * sdio_writeb - write a single byte to a SDIO function
392 * @func: SDIO function to access
394 * @addr: address to write to
395 * @err_ret: optional status value from transfer
397 * Writes a single byte to the address space of a given SDIO
398 * function. @err_ret will contain the status of the actual
401 void sdio_writeb(struct sdio_func *func, u8 b, unsigned int addr, int *err_ret)
407 ret = mmc_io_rw_direct(func->card, 1, func->num, addr, b, NULL);
411 EXPORT_SYMBOL_GPL(sdio_writeb);
414 * sdio_writeb_readb - write and read a byte from SDIO function
415 * @func: SDIO function to access
416 * @write_byte: byte to write
417 * @addr: address to write to
418 * @err_ret: optional status value from transfer
420 * Performs a RAW (Read after Write) operation as defined by SDIO spec -
421 * single byte is written to address space of a given SDIO function and
422 * response is read back from the same address, both using single request.
423 * If there is a problem with the operation, 0xff is returned and
424 * @err_ret will contain the error code.
426 u8 sdio_writeb_readb(struct sdio_func *func, u8 write_byte,
427 unsigned int addr, int *err_ret)
432 ret = mmc_io_rw_direct(func->card, 1, func->num, addr,
441 EXPORT_SYMBOL_GPL(sdio_writeb_readb);
444 * sdio_memcpy_fromio - read a chunk of memory from a SDIO function
445 * @func: SDIO function to access
446 * @dst: buffer to store the data
447 * @addr: address to begin reading from
448 * @count: number of bytes to read
450 * Reads from the address space of a given SDIO function. Return
451 * value indicates if the transfer succeeded or not.
453 int sdio_memcpy_fromio(struct sdio_func *func, void *dst,
454 unsigned int addr, int count)
456 return sdio_io_rw_ext_helper(func, 0, addr, 1, dst, count);
458 EXPORT_SYMBOL_GPL(sdio_memcpy_fromio);
461 * sdio_memcpy_toio - write a chunk of memory to a SDIO function
462 * @func: SDIO function to access
463 * @addr: address to start writing to
464 * @src: buffer that contains the data to write
465 * @count: number of bytes to write
467 * Writes to the address space of a given SDIO function. Return
468 * value indicates if the transfer succeeded or not.
470 int sdio_memcpy_toio(struct sdio_func *func, unsigned int addr,
471 void *src, int count)
473 return sdio_io_rw_ext_helper(func, 1, addr, 1, src, count);
475 EXPORT_SYMBOL_GPL(sdio_memcpy_toio);
478 * sdio_readsb - read from a FIFO on a SDIO function
479 * @func: SDIO function to access
480 * @dst: buffer to store the data
481 * @addr: address of (single byte) FIFO
482 * @count: number of bytes to read
484 * Reads from the specified FIFO of a given SDIO function. Return
485 * value indicates if the transfer succeeded or not.
487 int sdio_readsb(struct sdio_func *func, void *dst, unsigned int addr,
490 return sdio_io_rw_ext_helper(func, 0, addr, 0, dst, count);
492 EXPORT_SYMBOL_GPL(sdio_readsb);
495 * sdio_writesb - write to a FIFO of a SDIO function
496 * @func: SDIO function to access
497 * @addr: address of (single byte) FIFO
498 * @src: buffer that contains the data to write
499 * @count: number of bytes to write
501 * Writes to the specified FIFO of a given SDIO function. Return
502 * value indicates if the transfer succeeded or not.
504 int sdio_writesb(struct sdio_func *func, unsigned int addr, void *src,
507 return sdio_io_rw_ext_helper(func, 1, addr, 0, src, count);
509 EXPORT_SYMBOL_GPL(sdio_writesb);
512 * sdio_readw - read a 16 bit integer from a SDIO function
513 * @func: SDIO function to access
514 * @addr: address to read
515 * @err_ret: optional status value from transfer
517 * Reads a 16 bit integer from the address space of a given SDIO
518 * function. If there is a problem reading the address, 0xffff
519 * is returned and @err_ret will contain the error code.
521 u16 sdio_readw(struct sdio_func *func, unsigned int addr, int *err_ret)
528 ret = sdio_memcpy_fromio(func, func->tmpbuf, addr, 2);
535 return le16_to_cpup((__le16 *)func->tmpbuf);
537 EXPORT_SYMBOL_GPL(sdio_readw);
540 * sdio_writew - write a 16 bit integer to a SDIO function
541 * @func: SDIO function to access
542 * @b: integer to write
543 * @addr: address to write to
544 * @err_ret: optional status value from transfer
546 * Writes a 16 bit integer to the address space of a given SDIO
547 * function. @err_ret will contain the status of the actual
550 void sdio_writew(struct sdio_func *func, u16 b, unsigned int addr, int *err_ret)
554 *(__le16 *)func->tmpbuf = cpu_to_le16(b);
556 ret = sdio_memcpy_toio(func, addr, func->tmpbuf, 2);
560 EXPORT_SYMBOL_GPL(sdio_writew);
563 * sdio_readl - read a 32 bit integer from a SDIO function
564 * @func: SDIO function to access
565 * @addr: address to read
566 * @err_ret: optional status value from transfer
568 * Reads a 32 bit integer from the address space of a given SDIO
569 * function. If there is a problem reading the address,
570 * 0xffffffff is returned and @err_ret will contain the error
573 u32 sdio_readl(struct sdio_func *func, unsigned int addr, int *err_ret)
580 ret = sdio_memcpy_fromio(func, func->tmpbuf, addr, 4);
587 return le32_to_cpup((__le32 *)func->tmpbuf);
589 EXPORT_SYMBOL_GPL(sdio_readl);
592 * sdio_writel - write a 32 bit integer to a SDIO function
593 * @func: SDIO function to access
594 * @b: integer to write
595 * @addr: address to write to
596 * @err_ret: optional status value from transfer
598 * Writes a 32 bit integer to the address space of a given SDIO
599 * function. @err_ret will contain the status of the actual
602 void sdio_writel(struct sdio_func *func, u32 b, unsigned int addr, int *err_ret)
606 *(__le32 *)func->tmpbuf = cpu_to_le32(b);
608 ret = sdio_memcpy_toio(func, addr, func->tmpbuf, 4);
612 EXPORT_SYMBOL_GPL(sdio_writel);
615 * sdio_f0_readb - read a single byte from SDIO function 0
616 * @func: an SDIO function of the card
617 * @addr: address to read
618 * @err_ret: optional status value from transfer
620 * Reads a single byte from the address space of SDIO function 0.
621 * If there is a problem reading the address, 0xff is returned
622 * and @err_ret will contain the error code.
624 unsigned char sdio_f0_readb(struct sdio_func *func, unsigned int addr,
635 ret = mmc_io_rw_direct(func->card, 0, 0, addr, 0, &val);
644 EXPORT_SYMBOL_GPL(sdio_f0_readb);
647 * sdio_f0_writeb - write a single byte to SDIO function 0
648 * @func: an SDIO function of the card
650 * @addr: address to write to
651 * @err_ret: optional status value from transfer
653 * Writes a single byte to the address space of SDIO function 0.
654 * @err_ret will contain the status of the actual transfer.
656 * Only writes to the vendor specific CCCR registers (0xF0 -
657 * 0xFF) are permiited; @err_ret will be set to -EINVAL for *
658 * writes outside this range.
660 void sdio_f0_writeb(struct sdio_func *func, unsigned char b, unsigned int addr,
667 if ((addr < 0xF0 || addr > 0xFF) && (!mmc_card_lenient_fn0(func->card))) {
673 ret = mmc_io_rw_direct(func->card, 1, 0, addr, b, NULL);
677 EXPORT_SYMBOL_GPL(sdio_f0_writeb);
680 * sdio_get_host_pm_caps - get host power management capabilities
681 * @func: SDIO function attached to host
683 * Returns a capability bitmask corresponding to power management
684 * features supported by the host controller that the card function
685 * might rely upon during a system suspend. The host doesn't need
686 * to be claimed, nor the function active, for this information to be
689 mmc_pm_flag_t sdio_get_host_pm_caps(struct sdio_func *func)
694 return func->card->host->pm_caps;
696 EXPORT_SYMBOL_GPL(sdio_get_host_pm_caps);
699 * sdio_set_host_pm_flags - set wanted host power management capabilities
700 * @func: SDIO function attached to host
702 * Set a capability bitmask corresponding to wanted host controller
703 * power management features for the upcoming suspend state.
704 * This must be called, if needed, each time the suspend method of
705 * the function driver is called, and must contain only bits that
706 * were returned by sdio_get_host_pm_caps().
707 * The host doesn't need to be claimed, nor the function active,
708 * for this information to be set.
710 int sdio_set_host_pm_flags(struct sdio_func *func, mmc_pm_flag_t flags)
712 struct mmc_host *host;
717 host = func->card->host;
719 if (flags & ~host->pm_caps)
722 /* function suspend methods are serialized, hence no lock needed */
723 host->pm_flags |= flags;
726 EXPORT_SYMBOL_GPL(sdio_set_host_pm_flags);