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
return min(mval, 512u); /* maximum size for byte mode */
203
* sdio_align_size - pads a transfer size to a more optimal value
204
* @func: SDIO function
205
* @sz: original transfer size
207
* Pads the original data size with a number of extra bytes in
208
* order to avoid controller bugs and/or performance hits
209
* (e.g. some controllers revert to PIO for certain sizes).
211
* If possible, it will also adjust the size so that it can be
212
* handled in just a single request.
214
* Returns the improved size, which might be unmodified.
216
unsigned int sdio_align_size(struct sdio_func *func, unsigned int sz)
218
unsigned int orig_sz;
219
unsigned int blk_sz, byte_sz;
225
* Do a first check with the controller, in case it
226
* wants to increase the size up to a point where it
227
* might need more than one block.
229
sz = mmc_align_data_size(func->card, sz);
232
* If we can still do this with just a byte transfer, then
235
if (sz <= sdio_max_byte_size(func))
238
if (func->card->cccr.multi_block) {
240
* Check if the transfer is already block aligned
242
if ((sz % func->cur_blksize) == 0)
246
* Realign it so that it can be done with one request,
247
* and recheck if the controller still likes it.
249
blk_sz = ((sz + func->cur_blksize - 1) /
250
func->cur_blksize) * func->cur_blksize;
251
blk_sz = mmc_align_data_size(func->card, blk_sz);
254
* This value is only good if it is still just
257
if ((blk_sz % func->cur_blksize) == 0)
261
* We failed to do one request, but at least try to
262
* pad the remainder properly.
264
byte_sz = mmc_align_data_size(func->card,
265
sz % func->cur_blksize);
266
if (byte_sz <= sdio_max_byte_size(func)) {
267
blk_sz = sz / func->cur_blksize;
268
return blk_sz * func->cur_blksize + byte_sz;
272
* We need multiple requests, so first check that the
273
* controller can handle the chunk size;
275
chunk_sz = mmc_align_data_size(func->card,
276
sdio_max_byte_size(func));
277
if (chunk_sz == sdio_max_byte_size(func)) {
279
* Fix up the size of the remainder (if any)
281
byte_sz = orig_sz % chunk_sz;
283
byte_sz = mmc_align_data_size(func->card,
287
return (orig_sz / chunk_sz) * chunk_sz + byte_sz;
292
* The controller is simply incapable of transferring the size
293
* we want in decent manner, so just return the original size.
297
EXPORT_SYMBOL_GPL(sdio_align_size);
299
/* Split an arbitrarily sized data transfer into several
300
* IO_RW_EXTENDED commands. */
301
static int sdio_io_rw_ext_helper(struct sdio_func *func, int write,
302
unsigned addr, int incr_addr, u8 *buf, unsigned size)
304
unsigned remainder = size;
308
/* Do the bulk of the transfer using block mode (if supported). */
309
if (func->card->cccr.multi_block && (size > sdio_max_byte_size(func))) {
310
/* Blocks per command is limited by host count, host transfer
311
* size (we only use a single sg entry) and the maximum for
312
* IO_RW_EXTENDED of 511 blocks. */
313
max_blocks = min(func->card->host->max_blk_count,
314
func->card->host->max_seg_size / func->cur_blksize);
315
max_blocks = min(max_blocks, 511u);
317
while (remainder > func->cur_blksize) {
320
blocks = remainder / func->cur_blksize;
321
if (blocks > max_blocks)
323
size = blocks * func->cur_blksize;
325
ret = mmc_io_rw_extended(func->card, write,
326
func->num, addr, incr_addr, buf,
327
blocks, func->cur_blksize);
338
/* Write the remainder using byte mode. */
339
while (remainder > 0) {
340
size = min(remainder, sdio_max_byte_size(func));
342
ret = mmc_io_rw_extended(func->card, write, func->num, addr,
343
incr_addr, buf, 1, size);
356
* sdio_readb - read a single byte from a SDIO function
357
* @func: SDIO function to access
358
* @addr: address to read
359
* @err_ret: optional status value from transfer
361
* Reads a single byte from the address space of a given SDIO
362
* function. If there is a problem reading the address, 0xff
363
* is returned and @err_ret will contain the error code.
365
u8 sdio_readb(struct sdio_func *func, unsigned int addr, int *err_ret)
375
ret = mmc_io_rw_direct(func->card, 0, func->num, addr, 0, &val);
384
EXPORT_SYMBOL_GPL(sdio_readb);
387
* sdio_writeb - write a single byte to a SDIO function
388
* @func: SDIO function to access
390
* @addr: address to write to
391
* @err_ret: optional status value from transfer
393
* Writes a single byte to the address space of a given SDIO
394
* function. @err_ret will contain the status of the actual
397
void sdio_writeb(struct sdio_func *func, u8 b, unsigned int addr, int *err_ret)
403
ret = mmc_io_rw_direct(func->card, 1, func->num, addr, b, NULL);
407
EXPORT_SYMBOL_GPL(sdio_writeb);
410
* sdio_writeb_readb - write and read a byte from SDIO function
411
* @func: SDIO function to access
412
* @write_byte: byte to write
413
* @addr: address to write to
414
* @err_ret: optional status value from transfer
416
* Performs a RAW (Read after Write) operation as defined by SDIO spec -
417
* single byte is written to address space of a given SDIO function and
418
* response is read back from the same address, both using single request.
419
* If there is a problem with the operation, 0xff is returned and
420
* @err_ret will contain the error code.
422
u8 sdio_writeb_readb(struct sdio_func *func, u8 write_byte,
423
unsigned int addr, int *err_ret)
428
ret = mmc_io_rw_direct(func->card, 1, func->num, addr,
437
EXPORT_SYMBOL_GPL(sdio_writeb_readb);
440
* sdio_memcpy_fromio - read a chunk of memory from a SDIO function
441
* @func: SDIO function to access
442
* @dst: buffer to store the data
443
* @addr: address to begin reading from
444
* @count: number of bytes to read
446
* Reads from the address space of a given SDIO function. Return
447
* value indicates if the transfer succeeded or not.
449
int sdio_memcpy_fromio(struct sdio_func *func, void *dst,
450
unsigned int addr, int count)
452
return sdio_io_rw_ext_helper(func, 0, addr, 1, dst, count);
454
EXPORT_SYMBOL_GPL(sdio_memcpy_fromio);
457
* sdio_memcpy_toio - write a chunk of memory to a SDIO function
458
* @func: SDIO function to access
459
* @addr: address to start writing to
460
* @src: buffer that contains the data to write
461
* @count: number of bytes to write
463
* Writes to the address space of a given SDIO function. Return
464
* value indicates if the transfer succeeded or not.
466
int sdio_memcpy_toio(struct sdio_func *func, unsigned int addr,
467
void *src, int count)
469
return sdio_io_rw_ext_helper(func, 1, addr, 1, src, count);
471
EXPORT_SYMBOL_GPL(sdio_memcpy_toio);
474
* sdio_readsb - read from a FIFO on a SDIO function
475
* @func: SDIO function to access
476
* @dst: buffer to store the data
477
* @addr: address of (single byte) FIFO
478
* @count: number of bytes to read
480
* Reads from the specified FIFO of a given SDIO function. Return
481
* value indicates if the transfer succeeded or not.
483
int sdio_readsb(struct sdio_func *func, void *dst, unsigned int addr,
486
return sdio_io_rw_ext_helper(func, 0, addr, 0, dst, count);
488
EXPORT_SYMBOL_GPL(sdio_readsb);
491
* sdio_writesb - write to a FIFO of a SDIO function
492
* @func: SDIO function to access
493
* @addr: address of (single byte) FIFO
494
* @src: buffer that contains the data to write
495
* @count: number of bytes to write
497
* Writes to the specified FIFO of a given SDIO function. Return
498
* value indicates if the transfer succeeded or not.
500
int sdio_writesb(struct sdio_func *func, unsigned int addr, void *src,
503
return sdio_io_rw_ext_helper(func, 1, addr, 0, src, count);
505
EXPORT_SYMBOL_GPL(sdio_writesb);
508
* sdio_readw - read a 16 bit integer from a SDIO function
509
* @func: SDIO function to access
510
* @addr: address to read
511
* @err_ret: optional status value from transfer
513
* Reads a 16 bit integer from the address space of a given SDIO
514
* function. If there is a problem reading the address, 0xffff
515
* is returned and @err_ret will contain the error code.
517
u16 sdio_readw(struct sdio_func *func, unsigned int addr, int *err_ret)
524
ret = sdio_memcpy_fromio(func, func->tmpbuf, addr, 2);
531
return le16_to_cpup((__le16 *)func->tmpbuf);
533
EXPORT_SYMBOL_GPL(sdio_readw);
536
* sdio_writew - write a 16 bit integer to a SDIO function
537
* @func: SDIO function to access
538
* @b: integer to write
539
* @addr: address to write to
540
* @err_ret: optional status value from transfer
542
* Writes a 16 bit integer to the address space of a given SDIO
543
* function. @err_ret will contain the status of the actual
546
void sdio_writew(struct sdio_func *func, u16 b, unsigned int addr, int *err_ret)
550
*(__le16 *)func->tmpbuf = cpu_to_le16(b);
552
ret = sdio_memcpy_toio(func, addr, func->tmpbuf, 2);
556
EXPORT_SYMBOL_GPL(sdio_writew);
559
* sdio_readl - read a 32 bit integer from a SDIO function
560
* @func: SDIO function to access
561
* @addr: address to read
562
* @err_ret: optional status value from transfer
564
* Reads a 32 bit integer from the address space of a given SDIO
565
* function. If there is a problem reading the address,
566
* 0xffffffff is returned and @err_ret will contain the error
569
u32 sdio_readl(struct sdio_func *func, unsigned int addr, int *err_ret)
576
ret = sdio_memcpy_fromio(func, func->tmpbuf, addr, 4);
583
return le32_to_cpup((__le32 *)func->tmpbuf);
585
EXPORT_SYMBOL_GPL(sdio_readl);
588
* sdio_writel - write a 32 bit integer to a SDIO function
589
* @func: SDIO function to access
590
* @b: integer to write
591
* @addr: address to write to
592
* @err_ret: optional status value from transfer
594
* Writes a 32 bit integer to the address space of a given SDIO
595
* function. @err_ret will contain the status of the actual
598
void sdio_writel(struct sdio_func *func, u32 b, unsigned int addr, int *err_ret)
602
*(__le32 *)func->tmpbuf = cpu_to_le32(b);
604
ret = sdio_memcpy_toio(func, addr, func->tmpbuf, 4);
608
EXPORT_SYMBOL_GPL(sdio_writel);
611
* sdio_f0_readb - read a single byte from SDIO function 0
612
* @func: an SDIO function of the card
613
* @addr: address to read
614
* @err_ret: optional status value from transfer
616
* Reads a single byte from the address space of SDIO function 0.
617
* If there is a problem reading the address, 0xff is returned
618
* and @err_ret will contain the error code.
620
unsigned char sdio_f0_readb(struct sdio_func *func, unsigned int addr,
631
ret = mmc_io_rw_direct(func->card, 0, 0, addr, 0, &val);
640
EXPORT_SYMBOL_GPL(sdio_f0_readb);
643
* sdio_f0_writeb - write a single byte to SDIO function 0
644
* @func: an SDIO function of the card
646
* @addr: address to write to
647
* @err_ret: optional status value from transfer
649
* Writes a single byte to the address space of SDIO function 0.
650
* @err_ret will contain the status of the actual transfer.
652
* Only writes to the vendor specific CCCR registers (0xF0 -
653
* 0xFF) are permiited; @err_ret will be set to -EINVAL for *
654
* writes outside this range.
656
void sdio_f0_writeb(struct sdio_func *func, unsigned char b, unsigned int addr,
663
if ((addr < 0xF0 || addr > 0xFF) && (!mmc_card_lenient_fn0(func->card))) {
669
ret = mmc_io_rw_direct(func->card, 1, 0, addr, b, NULL);
673
EXPORT_SYMBOL_GPL(sdio_f0_writeb);
676
* sdio_get_host_pm_caps - get host power management capabilities
677
* @func: SDIO function attached to host
679
* Returns a capability bitmask corresponding to power management
680
* features supported by the host controller that the card function
681
* might rely upon during a system suspend. The host doesn't need
682
* to be claimed, nor the function active, for this information to be
685
mmc_pm_flag_t sdio_get_host_pm_caps(struct sdio_func *func)
690
return func->card->host->pm_caps;
692
EXPORT_SYMBOL_GPL(sdio_get_host_pm_caps);
695
* sdio_set_host_pm_flags - set wanted host power management capabilities
696
* @func: SDIO function attached to host
698
* Set a capability bitmask corresponding to wanted host controller
699
* power management features for the upcoming suspend state.
700
* This must be called, if needed, each time the suspend method of
701
* the function driver is called, and must contain only bits that
702
* were returned by sdio_get_host_pm_caps().
703
* The host doesn't need to be claimed, nor the function active,
704
* for this information to be set.
706
int sdio_set_host_pm_flags(struct sdio_func *func, mmc_pm_flag_t flags)
708
struct mmc_host *host;
713
host = func->card->host;
715
if (flags & ~host->pm_caps)
718
/* function suspend methods are serialized, hence no lock needed */
719
host->pm_flags |= flags;
722
EXPORT_SYMBOL_GPL(sdio_set_host_pm_flags);