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/mmc/host.h>
13 #include <linux/mmc/card.h>
14 #include <linux/mmc/sdio.h>
15 #include <linux/mmc/sdio_func.h>
20 * sdio_claim_host - exclusively claim a bus for a certain SDIO function
21 * @func: SDIO function that will be accessed
23 * Claim a bus for a set of operations. The SDIO function given
24 * is used to figure out which bus is relevant.
26 void sdio_claim_host(struct sdio_func
*func
)
31 mmc_claim_host(func
->card
->host
);
33 EXPORT_SYMBOL_GPL(sdio_claim_host
);
36 * sdio_release_host - release a bus for a certain SDIO function
37 * @func: SDIO function that was accessed
39 * Release a bus, allowing others to claim the bus for their
42 void sdio_release_host(struct sdio_func
*func
)
47 mmc_release_host(func
->card
->host
);
49 EXPORT_SYMBOL_GPL(sdio_release_host
);
52 * sdio_enable_func - enables a SDIO function for usage
53 * @func: SDIO function to enable
55 * Powers up and activates a SDIO function so that register
58 int sdio_enable_func(struct sdio_func
*func
)
62 unsigned long timeout
;
67 pr_debug("SDIO: Enabling device %s...\n", sdio_func_id(func
));
69 ret
= mmc_io_rw_direct(func
->card
, 0, 0, SDIO_CCCR_IOEx
, 0, ®
);
73 reg
|= 1 << func
->num
;
75 ret
= mmc_io_rw_direct(func
->card
, 1, 0, SDIO_CCCR_IOEx
, reg
, NULL
);
79 timeout
= jiffies
+ msecs_to_jiffies(func
->enable_timeout
);
82 ret
= mmc_io_rw_direct(func
->card
, 0, 0, SDIO_CCCR_IORx
, 0, ®
);
85 if (reg
& (1 << func
->num
))
88 if (time_after(jiffies
, timeout
))
92 pr_debug("SDIO: Enabled device %s\n", sdio_func_id(func
));
97 pr_debug("SDIO: Failed to enable device %s\n", sdio_func_id(func
));
100 EXPORT_SYMBOL_GPL(sdio_enable_func
);
103 * sdio_disable_func - disable a SDIO function
104 * @func: SDIO function to disable
106 * Powers down and deactivates a SDIO function. Register access
107 * to this function will fail until the function is reenabled.
109 int sdio_disable_func(struct sdio_func
*func
)
117 pr_debug("SDIO: Disabling device %s...\n", sdio_func_id(func
));
119 ret
= mmc_io_rw_direct(func
->card
, 0, 0, SDIO_CCCR_IOEx
, 0, ®
);
123 reg
&= ~(1 << func
->num
);
125 ret
= mmc_io_rw_direct(func
->card
, 1, 0, SDIO_CCCR_IOEx
, reg
, NULL
);
129 pr_debug("SDIO: Disabled device %s\n", sdio_func_id(func
));
134 pr_debug("SDIO: Failed to disable device %s\n", sdio_func_id(func
));
137 EXPORT_SYMBOL_GPL(sdio_disable_func
);
140 * sdio_set_block_size - set the block size of an SDIO function
141 * @func: SDIO function to change
142 * @blksz: new block size or 0 to use the default.
144 * The default block size is the largest supported by both the function
145 * and the host, with a maximum of 512 to ensure that arbitrarily sized
146 * data transfer use the optimal (least) number of commands.
148 * A driver may call this to override the default block size set by the
149 * core. This can be used to set a block size greater than the maximum
150 * that reported by the card; it is the driver's responsibility to ensure
151 * it uses a value that the card supports.
153 * Returns 0 on success, -EINVAL if the host does not support the
154 * requested block size, or -EIO (etc.) if one of the resultant FBR block
155 * size register writes failed.
158 int sdio_set_block_size(struct sdio_func
*func
, unsigned blksz
)
162 if (blksz
> func
->card
->host
->max_blk_size
)
166 blksz
= min(func
->max_blksize
, func
->card
->host
->max_blk_size
);
167 blksz
= min(blksz
, 512u);
170 ret
= mmc_io_rw_direct(func
->card
, 1, 0,
171 SDIO_FBR_BASE(func
->num
) + SDIO_FBR_BLKSIZE
,
175 ret
= mmc_io_rw_direct(func
->card
, 1, 0,
176 SDIO_FBR_BASE(func
->num
) + SDIO_FBR_BLKSIZE
+ 1,
177 (blksz
>> 8) & 0xff, NULL
);
180 func
->cur_blksize
= blksz
;
183 EXPORT_SYMBOL_GPL(sdio_set_block_size
);
186 * Calculate the maximum byte mode transfer size
188 static inline unsigned int sdio_max_byte_size(struct sdio_func
*func
)
190 unsigned mval
= min(func
->card
->host
->max_seg_size
,
191 func
->card
->host
->max_blk_size
);
192 mval
= min(mval
, func
->max_blksize
);
193 return min(mval
, 512u); /* maximum size for byte mode */
197 * sdio_align_size - pads a transfer size to a more optimal value
198 * @func: SDIO function
199 * @sz: original transfer size
201 * Pads the original data size with a number of extra bytes in
202 * order to avoid controller bugs and/or performance hits
203 * (e.g. some controllers revert to PIO for certain sizes).
205 * If possible, it will also adjust the size so that it can be
206 * handled in just a single request.
208 * Returns the improved size, which might be unmodified.
210 unsigned int sdio_align_size(struct sdio_func
*func
, unsigned int sz
)
212 unsigned int orig_sz
;
213 unsigned int blk_sz
, byte_sz
;
219 * Do a first check with the controller, in case it
220 * wants to increase the size up to a point where it
221 * might need more than one block.
223 sz
= mmc_align_data_size(func
->card
, sz
);
226 * If we can still do this with just a byte transfer, then
229 if (sz
<= sdio_max_byte_size(func
))
232 if (func
->card
->cccr
.multi_block
) {
234 * Check if the transfer is already block aligned
236 if ((sz
% func
->cur_blksize
) == 0)
240 * Realign it so that it can be done with one request,
241 * and recheck if the controller still likes it.
243 blk_sz
= ((sz
+ func
->cur_blksize
- 1) /
244 func
->cur_blksize
) * func
->cur_blksize
;
245 blk_sz
= mmc_align_data_size(func
->card
, blk_sz
);
248 * This value is only good if it is still just
251 if ((blk_sz
% func
->cur_blksize
) == 0)
255 * We failed to do one request, but at least try to
256 * pad the remainder properly.
258 byte_sz
= mmc_align_data_size(func
->card
,
259 sz
% func
->cur_blksize
);
260 if (byte_sz
<= sdio_max_byte_size(func
)) {
261 blk_sz
= sz
/ func
->cur_blksize
;
262 return blk_sz
* func
->cur_blksize
+ byte_sz
;
266 * We need multiple requests, so first check that the
267 * controller can handle the chunk size;
269 chunk_sz
= mmc_align_data_size(func
->card
,
270 sdio_max_byte_size(func
));
271 if (chunk_sz
== sdio_max_byte_size(func
)) {
273 * Fix up the size of the remainder (if any)
275 byte_sz
= orig_sz
% chunk_sz
;
277 byte_sz
= mmc_align_data_size(func
->card
,
281 return (orig_sz
/ chunk_sz
) * chunk_sz
+ byte_sz
;
286 * The controller is simply incapable of transferring the size
287 * we want in decent manner, so just return the original size.
291 EXPORT_SYMBOL_GPL(sdio_align_size
);
293 /* Split an arbitrarily sized data transfer into several
294 * IO_RW_EXTENDED commands. */
295 static int sdio_io_rw_ext_helper(struct sdio_func
*func
, int write
,
296 unsigned addr
, int incr_addr
, u8
*buf
, unsigned size
)
298 unsigned remainder
= size
;
302 /* Do the bulk of the transfer using block mode (if supported). */
303 if (func
->card
->cccr
.multi_block
&& (size
> sdio_max_byte_size(func
))) {
304 /* Blocks per command is limited by host count, host transfer
305 * size (we only use a single sg entry) and the maximum for
306 * IO_RW_EXTENDED of 511 blocks. */
307 max_blocks
= min(func
->card
->host
->max_blk_count
,
308 func
->card
->host
->max_seg_size
/ func
->cur_blksize
);
309 max_blocks
= min(max_blocks
, 511u);
311 while (remainder
> func
->cur_blksize
) {
314 blocks
= remainder
/ func
->cur_blksize
;
315 if (blocks
> max_blocks
)
317 size
= blocks
* func
->cur_blksize
;
319 ret
= mmc_io_rw_extended(func
->card
, write
,
320 func
->num
, addr
, incr_addr
, buf
,
321 blocks
, func
->cur_blksize
);
332 /* Write the remainder using byte mode. */
333 while (remainder
> 0) {
334 size
= min(remainder
, sdio_max_byte_size(func
));
336 ret
= mmc_io_rw_extended(func
->card
, write
, func
->num
, addr
,
337 incr_addr
, buf
, 1, size
);
350 * sdio_readb - read a single byte from a SDIO function
351 * @func: SDIO function to access
352 * @addr: address to read
353 * @err_ret: optional status value from transfer
355 * Reads a single byte from the address space of a given SDIO
356 * function. If there is a problem reading the address, 0xff
357 * is returned and @err_ret will contain the error code.
359 u8
sdio_readb(struct sdio_func
*func
, unsigned int addr
, int *err_ret
)
369 ret
= mmc_io_rw_direct(func
->card
, 0, func
->num
, addr
, 0, &val
);
378 EXPORT_SYMBOL_GPL(sdio_readb
);
381 * sdio_writeb - write a single byte to a SDIO function
382 * @func: SDIO function to access
384 * @addr: address to write to
385 * @err_ret: optional status value from transfer
387 * Writes a single byte to the address space of a given SDIO
388 * function. @err_ret will contain the status of the actual
391 void sdio_writeb(struct sdio_func
*func
, u8 b
, unsigned int addr
, int *err_ret
)
397 ret
= mmc_io_rw_direct(func
->card
, 1, func
->num
, addr
, b
, NULL
);
401 EXPORT_SYMBOL_GPL(sdio_writeb
);
404 * sdio_memcpy_fromio - read a chunk of memory from a SDIO function
405 * @func: SDIO function to access
406 * @dst: buffer to store the data
407 * @addr: address to begin reading from
408 * @count: number of bytes to read
410 * Reads from the address space of a given SDIO function. Return
411 * value indicates if the transfer succeeded or not.
413 int sdio_memcpy_fromio(struct sdio_func
*func
, void *dst
,
414 unsigned int addr
, int count
)
416 return sdio_io_rw_ext_helper(func
, 0, addr
, 1, dst
, count
);
418 EXPORT_SYMBOL_GPL(sdio_memcpy_fromio
);
421 * sdio_memcpy_toio - write a chunk of memory to a SDIO function
422 * @func: SDIO function to access
423 * @addr: address to start writing to
424 * @src: buffer that contains the data to write
425 * @count: number of bytes to write
427 * Writes to the address space of a given SDIO function. Return
428 * value indicates if the transfer succeeded or not.
430 int sdio_memcpy_toio(struct sdio_func
*func
, unsigned int addr
,
431 void *src
, int count
)
433 return sdio_io_rw_ext_helper(func
, 1, addr
, 1, src
, count
);
435 EXPORT_SYMBOL_GPL(sdio_memcpy_toio
);
438 * sdio_readsb - read from a FIFO on a SDIO function
439 * @func: SDIO function to access
440 * @dst: buffer to store the data
441 * @addr: address of (single byte) FIFO
442 * @count: number of bytes to read
444 * Reads from the specified FIFO of a given SDIO function. Return
445 * value indicates if the transfer succeeded or not.
447 int sdio_readsb(struct sdio_func
*func
, void *dst
, unsigned int addr
,
450 return sdio_io_rw_ext_helper(func
, 0, addr
, 0, dst
, count
);
452 EXPORT_SYMBOL_GPL(sdio_readsb
);
455 * sdio_writesb - write to a FIFO of a SDIO function
456 * @func: SDIO function to access
457 * @addr: address of (single byte) FIFO
458 * @src: buffer that contains the data to write
459 * @count: number of bytes to write
461 * Writes to the specified FIFO of a given SDIO function. Return
462 * value indicates if the transfer succeeded or not.
464 int sdio_writesb(struct sdio_func
*func
, unsigned int addr
, void *src
,
467 return sdio_io_rw_ext_helper(func
, 1, addr
, 0, src
, count
);
469 EXPORT_SYMBOL_GPL(sdio_writesb
);
472 * sdio_readw - read a 16 bit integer from a SDIO function
473 * @func: SDIO function to access
474 * @addr: address to read
475 * @err_ret: optional status value from transfer
477 * Reads a 16 bit integer from the address space of a given SDIO
478 * function. If there is a problem reading the address, 0xffff
479 * is returned and @err_ret will contain the error code.
481 u16
sdio_readw(struct sdio_func
*func
, unsigned int addr
, int *err_ret
)
488 ret
= sdio_memcpy_fromio(func
, func
->tmpbuf
, addr
, 2);
495 return le16_to_cpup((__le16
*)func
->tmpbuf
);
497 EXPORT_SYMBOL_GPL(sdio_readw
);
500 * sdio_writew - write a 16 bit integer to a SDIO function
501 * @func: SDIO function to access
502 * @b: integer to write
503 * @addr: address to write to
504 * @err_ret: optional status value from transfer
506 * Writes a 16 bit integer to the address space of a given SDIO
507 * function. @err_ret will contain the status of the actual
510 void sdio_writew(struct sdio_func
*func
, u16 b
, unsigned int addr
, int *err_ret
)
514 *(__le16
*)func
->tmpbuf
= cpu_to_le16(b
);
516 ret
= sdio_memcpy_toio(func
, addr
, func
->tmpbuf
, 2);
520 EXPORT_SYMBOL_GPL(sdio_writew
);
523 * sdio_readl - read a 32 bit integer from a SDIO function
524 * @func: SDIO function to access
525 * @addr: address to read
526 * @err_ret: optional status value from transfer
528 * Reads a 32 bit integer from the address space of a given SDIO
529 * function. If there is a problem reading the address,
530 * 0xffffffff is returned and @err_ret will contain the error
533 u32
sdio_readl(struct sdio_func
*func
, unsigned int addr
, int *err_ret
)
540 ret
= sdio_memcpy_fromio(func
, func
->tmpbuf
, addr
, 4);
547 return le32_to_cpup((__le32
*)func
->tmpbuf
);
549 EXPORT_SYMBOL_GPL(sdio_readl
);
552 * sdio_writel - write a 32 bit integer to a SDIO function
553 * @func: SDIO function to access
554 * @b: integer to write
555 * @addr: address to write to
556 * @err_ret: optional status value from transfer
558 * Writes a 32 bit integer to the address space of a given SDIO
559 * function. @err_ret will contain the status of the actual
562 void sdio_writel(struct sdio_func
*func
, u32 b
, unsigned int addr
, int *err_ret
)
566 *(__le32
*)func
->tmpbuf
= cpu_to_le32(b
);
568 ret
= sdio_memcpy_toio(func
, addr
, func
->tmpbuf
, 4);
572 EXPORT_SYMBOL_GPL(sdio_writel
);
575 * sdio_f0_readb - read a single byte from SDIO function 0
576 * @func: an SDIO function of the card
577 * @addr: address to read
578 * @err_ret: optional status value from transfer
580 * Reads a single byte from the address space of SDIO function 0.
581 * If there is a problem reading the address, 0xff is returned
582 * and @err_ret will contain the error code.
584 unsigned char sdio_f0_readb(struct sdio_func
*func
, unsigned int addr
,
595 ret
= mmc_io_rw_direct(func
->card
, 0, 0, addr
, 0, &val
);
604 EXPORT_SYMBOL_GPL(sdio_f0_readb
);
607 * sdio_f0_writeb - write a single byte to SDIO function 0
608 * @func: an SDIO function of the card
610 * @addr: address to write to
611 * @err_ret: optional status value from transfer
613 * Writes a single byte to the address space of SDIO function 0.
614 * @err_ret will contain the status of the actual transfer.
616 * Only writes to the vendor specific CCCR registers (0xF0 -
617 * 0xFF) are permiited; @err_ret will be set to -EINVAL for *
618 * writes outside this range.
620 void sdio_f0_writeb(struct sdio_func
*func
, unsigned char b
, unsigned int addr
,
627 if (addr
< 0xF0 || addr
> 0xFF) {
633 ret
= mmc_io_rw_direct(func
->card
, 1, 0, addr
, b
, NULL
);
637 EXPORT_SYMBOL_GPL(sdio_f0_writeb
);