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 = func->card->host->max_blk_size;
193 if (mmc_blksz_for_byte_mode(func->card))
194 mval = min(mval, func->cur_blksize);
196 mval = min(mval, func->max_blksize);
198 if (mmc_card_broken_byte_mode_512(func->card))
199 return min(mval, 511u);
201 return min(mval, 512u); /* maximum size for byte mode */
205 * sdio_align_size - pads a transfer size to a more optimal value
206 * @func: SDIO function
207 * @sz: original transfer size
209 * Pads the original data size with a number of extra bytes in
210 * order to avoid controller bugs and/or performance hits
211 * (e.g. some controllers revert to PIO for certain sizes).
213 * If possible, it will also adjust the size so that it can be
214 * handled in just a single request.
216 * Returns the improved size, which might be unmodified.
218 unsigned int sdio_align_size(struct sdio_func *func, unsigned int sz)
220 unsigned int orig_sz;
221 unsigned int blk_sz, byte_sz;
227 * Do a first check with the controller, in case it
228 * wants to increase the size up to a point where it
229 * might need more than one block.
231 sz = mmc_align_data_size(func->card, sz);
234 * If we can still do this with just a byte transfer, then
237 if (sz <= sdio_max_byte_size(func))
240 if (func->card->cccr.multi_block) {
242 * Check if the transfer is already block aligned
244 if ((sz % func->cur_blksize) == 0)
248 * Realign it so that it can be done with one request,
249 * and recheck if the controller still likes it.
251 blk_sz = ((sz + func->cur_blksize - 1) /
252 func->cur_blksize) * func->cur_blksize;
253 blk_sz = mmc_align_data_size(func->card, blk_sz);
256 * This value is only good if it is still just
259 if ((blk_sz % func->cur_blksize) == 0)
263 * We failed to do one request, but at least try to
264 * pad the remainder properly.
266 byte_sz = mmc_align_data_size(func->card,
267 sz % func->cur_blksize);
268 if (byte_sz <= sdio_max_byte_size(func)) {
269 blk_sz = sz / func->cur_blksize;
270 return blk_sz * func->cur_blksize + byte_sz;
274 * We need multiple requests, so first check that the
275 * controller can handle the chunk size;
277 chunk_sz = mmc_align_data_size(func->card,
278 sdio_max_byte_size(func));
279 if (chunk_sz == sdio_max_byte_size(func)) {
281 * Fix up the size of the remainder (if any)
283 byte_sz = orig_sz % chunk_sz;
285 byte_sz = mmc_align_data_size(func->card,
289 return (orig_sz / chunk_sz) * chunk_sz + byte_sz;
294 * The controller is simply incapable of transferring the size
295 * we want in decent manner, so just return the original size.
299 EXPORT_SYMBOL_GPL(sdio_align_size);
301 /* Split an arbitrarily sized data transfer into several
302 * IO_RW_EXTENDED commands. */
303 static int sdio_io_rw_ext_helper(struct sdio_func *func, int write,
304 unsigned addr, int incr_addr, u8 *buf, unsigned size)
306 unsigned remainder = size;
310 if (!func || (func->num > 7))
313 /* Do the bulk of the transfer using block mode (if supported). */
314 if (func->card->cccr.multi_block && (size > sdio_max_byte_size(func))) {
315 /* Blocks per command is limited by host count, host transfer
316 * size and the maximum for IO_RW_EXTENDED of 511 blocks. */
317 max_blocks = min(func->card->host->max_blk_count, 511u);
319 while (remainder >= func->cur_blksize) {
322 blocks = remainder / func->cur_blksize;
323 if (blocks > max_blocks)
325 size = blocks * func->cur_blksize;
327 ret = mmc_io_rw_extended(func->card, write,
328 func->num, addr, incr_addr, buf,
329 blocks, func->cur_blksize);
340 /* Write the remainder using byte mode. */
341 while (remainder > 0) {
342 size = min(remainder, sdio_max_byte_size(func));
344 /* Indicate byte mode by setting "blocks" = 0 */
345 ret = mmc_io_rw_extended(func->card, write, func->num, addr,
346 incr_addr, buf, 0, size);
359 * sdio_readb - read a single byte from a SDIO function
360 * @func: SDIO function to access
361 * @addr: address to read
362 * @err_ret: optional status value from transfer
364 * Reads a single byte from the address space of a given SDIO
365 * function. If there is a problem reading the address, 0xff
366 * is returned and @err_ret will contain the error code.
368 u8 sdio_readb(struct sdio_func *func, unsigned int addr, int *err_ret)
381 ret = mmc_io_rw_direct(func->card, 0, func->num, addr, 0, &val);
390 EXPORT_SYMBOL_GPL(sdio_readb);
393 * sdio_writeb - write a single byte to a SDIO function
394 * @func: SDIO function to access
396 * @addr: address to write to
397 * @err_ret: optional status value from transfer
399 * Writes a single byte to the address space of a given SDIO
400 * function. @err_ret will contain the status of the actual
403 void sdio_writeb(struct sdio_func *func, u8 b, unsigned int addr, int *err_ret)
412 ret = mmc_io_rw_direct(func->card, 1, func->num, addr, b, NULL);
416 EXPORT_SYMBOL_GPL(sdio_writeb);
419 * sdio_writeb_readb - write and read a byte from SDIO function
420 * @func: SDIO function to access
421 * @write_byte: byte to write
422 * @addr: address to write to
423 * @err_ret: optional status value from transfer
425 * Performs a RAW (Read after Write) operation as defined by SDIO spec -
426 * single byte is written to address space of a given SDIO function and
427 * response is read back from the same address, both using single request.
428 * If there is a problem with the operation, 0xff is returned and
429 * @err_ret will contain the error code.
431 u8 sdio_writeb_readb(struct sdio_func *func, u8 write_byte,
432 unsigned int addr, int *err_ret)
437 ret = mmc_io_rw_direct(func->card, 1, func->num, addr,
446 EXPORT_SYMBOL_GPL(sdio_writeb_readb);
449 * sdio_memcpy_fromio - read a chunk of memory from a SDIO function
450 * @func: SDIO function to access
451 * @dst: buffer to store the data
452 * @addr: address to begin reading from
453 * @count: number of bytes to read
455 * Reads from the address space of a given SDIO function. Return
456 * value indicates if the transfer succeeded or not.
458 int sdio_memcpy_fromio(struct sdio_func *func, void *dst,
459 unsigned int addr, int count)
461 return sdio_io_rw_ext_helper(func, 0, addr, 1, dst, count);
463 EXPORT_SYMBOL_GPL(sdio_memcpy_fromio);
466 * sdio_memcpy_toio - write a chunk of memory to a SDIO function
467 * @func: SDIO function to access
468 * @addr: address to start writing to
469 * @src: buffer that contains the data to write
470 * @count: number of bytes to write
472 * Writes to the address space of a given SDIO function. Return
473 * value indicates if the transfer succeeded or not.
475 int sdio_memcpy_toio(struct sdio_func *func, unsigned int addr,
476 void *src, int count)
478 return sdio_io_rw_ext_helper(func, 1, addr, 1, src, count);
480 EXPORT_SYMBOL_GPL(sdio_memcpy_toio);
483 * sdio_readsb - read from a FIFO on a SDIO function
484 * @func: SDIO function to access
485 * @dst: buffer to store the data
486 * @addr: address of (single byte) FIFO
487 * @count: number of bytes to read
489 * Reads from the specified FIFO of a given SDIO function. Return
490 * value indicates if the transfer succeeded or not.
492 int sdio_readsb(struct sdio_func *func, void *dst, unsigned int addr,
495 return sdio_io_rw_ext_helper(func, 0, addr, 0, dst, count);
497 EXPORT_SYMBOL_GPL(sdio_readsb);
500 * sdio_writesb - write to a FIFO of a SDIO function
501 * @func: SDIO function to access
502 * @addr: address of (single byte) FIFO
503 * @src: buffer that contains the data to write
504 * @count: number of bytes to write
506 * Writes to the specified FIFO of a given SDIO function. Return
507 * value indicates if the transfer succeeded or not.
509 int sdio_writesb(struct sdio_func *func, unsigned int addr, void *src,
512 return sdio_io_rw_ext_helper(func, 1, addr, 0, src, count);
514 EXPORT_SYMBOL_GPL(sdio_writesb);
517 * sdio_readw - read a 16 bit integer from a SDIO function
518 * @func: SDIO function to access
519 * @addr: address to read
520 * @err_ret: optional status value from transfer
522 * Reads a 16 bit integer from the address space of a given SDIO
523 * function. If there is a problem reading the address, 0xffff
524 * is returned and @err_ret will contain the error code.
526 u16 sdio_readw(struct sdio_func *func, unsigned int addr, int *err_ret)
533 ret = sdio_memcpy_fromio(func, func->tmpbuf, addr, 2);
540 return le16_to_cpup((__le16 *)func->tmpbuf);
542 EXPORT_SYMBOL_GPL(sdio_readw);
545 * sdio_writew - write a 16 bit integer to a SDIO function
546 * @func: SDIO function to access
547 * @b: integer to write
548 * @addr: address to write to
549 * @err_ret: optional status value from transfer
551 * Writes a 16 bit integer to the address space of a given SDIO
552 * function. @err_ret will contain the status of the actual
555 void sdio_writew(struct sdio_func *func, u16 b, unsigned int addr, int *err_ret)
559 *(__le16 *)func->tmpbuf = cpu_to_le16(b);
561 ret = sdio_memcpy_toio(func, addr, func->tmpbuf, 2);
565 EXPORT_SYMBOL_GPL(sdio_writew);
568 * sdio_readl - read a 32 bit integer from a SDIO function
569 * @func: SDIO function to access
570 * @addr: address to read
571 * @err_ret: optional status value from transfer
573 * Reads a 32 bit integer from the address space of a given SDIO
574 * function. If there is a problem reading the address,
575 * 0xffffffff is returned and @err_ret will contain the error
578 u32 sdio_readl(struct sdio_func *func, unsigned int addr, int *err_ret)
585 ret = sdio_memcpy_fromio(func, func->tmpbuf, addr, 4);
592 return le32_to_cpup((__le32 *)func->tmpbuf);
594 EXPORT_SYMBOL_GPL(sdio_readl);
597 * sdio_writel - write a 32 bit integer to a SDIO function
598 * @func: SDIO function to access
599 * @b: integer to write
600 * @addr: address to write to
601 * @err_ret: optional status value from transfer
603 * Writes a 32 bit integer to the address space of a given SDIO
604 * function. @err_ret will contain the status of the actual
607 void sdio_writel(struct sdio_func *func, u32 b, unsigned int addr, int *err_ret)
611 *(__le32 *)func->tmpbuf = cpu_to_le32(b);
613 ret = sdio_memcpy_toio(func, addr, func->tmpbuf, 4);
617 EXPORT_SYMBOL_GPL(sdio_writel);
620 * sdio_f0_readb - read a single byte from SDIO function 0
621 * @func: an SDIO function of the card
622 * @addr: address to read
623 * @err_ret: optional status value from transfer
625 * Reads a single byte from the address space of SDIO function 0.
626 * If there is a problem reading the address, 0xff is returned
627 * and @err_ret will contain the error code.
629 unsigned char sdio_f0_readb(struct sdio_func *func, unsigned int addr,
643 ret = mmc_io_rw_direct(func->card, 0, 0, addr, 0, &val);
652 EXPORT_SYMBOL_GPL(sdio_f0_readb);
655 * sdio_f0_writeb - write a single byte to SDIO function 0
656 * @func: an SDIO function of the card
658 * @addr: address to write to
659 * @err_ret: optional status value from transfer
661 * Writes a single byte to the address space of SDIO function 0.
662 * @err_ret will contain the status of the actual transfer.
664 * Only writes to the vendor specific CCCR registers (0xF0 -
665 * 0xFF) are permiited; @err_ret will be set to -EINVAL for *
666 * writes outside this range.
668 void sdio_f0_writeb(struct sdio_func *func, unsigned char b, unsigned int addr,
678 if ((addr < 0xF0 || addr > 0xFF) && (!mmc_card_lenient_fn0(func->card))) {
684 ret = mmc_io_rw_direct(func->card, 1, 0, addr, b, NULL);
688 EXPORT_SYMBOL_GPL(sdio_f0_writeb);
691 * sdio_get_host_pm_caps - get host power management capabilities
692 * @func: SDIO function attached to host
694 * Returns a capability bitmask corresponding to power management
695 * features supported by the host controller that the card function
696 * might rely upon during a system suspend. The host doesn't need
697 * to be claimed, nor the function active, for this information to be
700 mmc_pm_flag_t sdio_get_host_pm_caps(struct sdio_func *func)
705 return func->card->host->pm_caps;
707 EXPORT_SYMBOL_GPL(sdio_get_host_pm_caps);
710 * sdio_set_host_pm_flags - set wanted host power management capabilities
711 * @func: SDIO function attached to host
713 * Set a capability bitmask corresponding to wanted host controller
714 * power management features for the upcoming suspend state.
715 * This must be called, if needed, each time the suspend method of
716 * the function driver is called, and must contain only bits that
717 * were returned by sdio_get_host_pm_caps().
718 * The host doesn't need to be claimed, nor the function active,
719 * for this information to be set.
721 int sdio_set_host_pm_flags(struct sdio_func *func, mmc_pm_flag_t flags)
723 struct mmc_host *host;
728 host = func->card->host;
730 if (flags & ~host->pm_caps)
733 /* function suspend methods are serialized, hence no lock needed */
734 host->pm_flags |= flags;
737 EXPORT_SYMBOL_GPL(sdio_set_host_pm_flags);