Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
Pierre Ossman | aaac1b4 | 2007-02-28 15:33:10 +0100 | [diff] [blame] | 2 | * linux/include/linux/mmc/core.h |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 3 | * |
| 4 | * This program is free software; you can redistribute it and/or modify |
| 5 | * it under the terms of the GNU General Public License version 2 as |
| 6 | * published by the Free Software Foundation. |
| 7 | */ |
Pierre Ossman | aaac1b4 | 2007-02-28 15:33:10 +0100 | [diff] [blame] | 8 | #ifndef LINUX_MMC_CORE_H |
| 9 | #define LINUX_MMC_CORE_H |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 10 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 | #include <linux/interrupt.h> |
| 12 | #include <linux/device.h> |
| 13 | |
| 14 | struct request; |
| 15 | struct mmc_data; |
| 16 | struct mmc_request; |
| 17 | |
| 18 | struct mmc_command { |
| 19 | u32 opcode; |
| 20 | u32 arg; |
| 21 | u32 resp[4]; |
| 22 | unsigned int flags; /* expected response type */ |
Russell King | e922517 | 2006-02-02 12:23:12 +0000 | [diff] [blame] | 23 | #define MMC_RSP_PRESENT (1 << 0) |
| 24 | #define MMC_RSP_136 (1 << 1) /* 136 bit response */ |
| 25 | #define MMC_RSP_CRC (1 << 2) /* expect valid crc */ |
| 26 | #define MMC_RSP_BUSY (1 << 3) /* card may send busy */ |
| 27 | #define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */ |
David Brownell | 9701858 | 2007-08-08 09:09:01 -0700 | [diff] [blame] | 28 | |
| 29 | #define MMC_CMD_MASK (3 << 5) /* non-SPI command type */ |
Russell King | e922517 | 2006-02-02 12:23:12 +0000 | [diff] [blame] | 30 | #define MMC_CMD_AC (0 << 5) |
| 31 | #define MMC_CMD_ADTC (1 << 5) |
| 32 | #define MMC_CMD_BC (2 << 5) |
| 33 | #define MMC_CMD_BCR (3 << 5) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 | |
David Brownell | 9701858 | 2007-08-08 09:09:01 -0700 | [diff] [blame] | 35 | #define MMC_RSP_SPI_S1 (1 << 7) /* one status byte */ |
| 36 | #define MMC_RSP_SPI_S2 (1 << 8) /* second byte */ |
| 37 | #define MMC_RSP_SPI_B4 (1 << 9) /* four data bytes */ |
| 38 | #define MMC_RSP_SPI_BUSY (1 << 10) /* card may send busy */ |
| 39 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 40 | /* |
David Brownell | 9701858 | 2007-08-08 09:09:01 -0700 | [diff] [blame] | 41 | * These are the native response types, and correspond to valid bit |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 42 | * patterns of the above flags. One additional valid pattern |
| 43 | * is all zeros, which means we don't expect a response. |
| 44 | */ |
Russell King | e922517 | 2006-02-02 12:23:12 +0000 | [diff] [blame] | 45 | #define MMC_RSP_NONE (0) |
| 46 | #define MMC_RSP_R1 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
| 47 | #define MMC_RSP_R1B (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE|MMC_RSP_BUSY) |
| 48 | #define MMC_RSP_R2 (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC) |
| 49 | #define MMC_RSP_R3 (MMC_RSP_PRESENT) |
Pierre Ossman | 5c4e6f1 | 2007-05-21 20:23:20 +0200 | [diff] [blame] | 50 | #define MMC_RSP_R4 (MMC_RSP_PRESENT) |
Pierre Ossman | b2bcc79 | 2007-05-22 20:25:21 +0200 | [diff] [blame] | 51 | #define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
Philip Langdale | 6f94990 | 2007-01-04 07:04:47 -0800 | [diff] [blame] | 52 | #define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
Philip Langdale | fba68bd | 2007-01-04 06:57:32 -0800 | [diff] [blame] | 53 | #define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE) |
Russell King | e922517 | 2006-02-02 12:23:12 +0000 | [diff] [blame] | 54 | |
| 55 | #define mmc_resp_type(cmd) ((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE)) |
| 56 | |
| 57 | /* |
David Brownell | 9701858 | 2007-08-08 09:09:01 -0700 | [diff] [blame] | 58 | * These are the SPI response types for MMC, SD, and SDIO cards. |
| 59 | * Commands return R1, with maybe more info. Zero is an error type; |
| 60 | * callers must always provide the appropriate MMC_RSP_SPI_Rx flags. |
| 61 | */ |
| 62 | #define MMC_RSP_SPI_R1 (MMC_RSP_SPI_S1) |
| 63 | #define MMC_RSP_SPI_R1B (MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY) |
| 64 | #define MMC_RSP_SPI_R2 (MMC_RSP_SPI_S1|MMC_RSP_SPI_S2) |
| 65 | #define MMC_RSP_SPI_R3 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) |
| 66 | #define MMC_RSP_SPI_R4 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) |
| 67 | #define MMC_RSP_SPI_R5 (MMC_RSP_SPI_S1|MMC_RSP_SPI_S2) |
| 68 | #define MMC_RSP_SPI_R7 (MMC_RSP_SPI_S1|MMC_RSP_SPI_B4) |
| 69 | |
| 70 | #define mmc_spi_resp_type(cmd) ((cmd)->flags & \ |
| 71 | (MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY|MMC_RSP_SPI_S2|MMC_RSP_SPI_B4)) |
| 72 | |
| 73 | /* |
Russell King | e922517 | 2006-02-02 12:23:12 +0000 | [diff] [blame] | 74 | * These are the command types. |
| 75 | */ |
Russell King | 5bd546a | 2006-02-17 20:23:29 +0000 | [diff] [blame] | 76 | #define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | |
| 78 | unsigned int retries; /* max number of retries */ |
| 79 | unsigned int error; /* command error */ |
| 80 | |
Pierre Ossman | 17b0429 | 2007-07-22 22:18:46 +0200 | [diff] [blame] | 81 | /* |
| 82 | * Standard errno values are used for errors, but some have specific |
| 83 | * meaning in the MMC layer: |
| 84 | * |
| 85 | * ETIMEDOUT Card took too long to respond |
| 86 | * EILSEQ Basic format problem with the received or sent data |
| 87 | * (e.g. CRC check failed, incorrect opcode in response |
| 88 | * or bad end bit) |
| 89 | * EINVAL Request cannot be performed because of restrictions |
| 90 | * in hardware and/or the driver |
| 91 | * ENOMEDIUM Host can determine that the slot is empty and is |
| 92 | * actively failing requests |
| 93 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | |
Andrei Warkentin | eaa02f7 | 2011-04-11 16:13:41 -0500 | [diff] [blame] | 95 | unsigned int cmd_timeout_ms; /* in milliseconds */ |
Adrian Hunter | dfe86cb | 2010-08-11 14:17:46 -0700 | [diff] [blame] | 96 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 97 | struct mmc_data *data; /* data segment associated with cmd */ |
Erik Hovland | 8573b80 | 2005-10-28 16:28:04 +0100 | [diff] [blame] | 98 | struct mmc_request *mrq; /* associated request */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 99 | }; |
| 100 | |
| 101 | struct mmc_data { |
| 102 | unsigned int timeout_ns; /* data timeout (in ns, max 80ms) */ |
| 103 | unsigned int timeout_clks; /* data timeout (in clocks) */ |
Pavel Pisa | 2c171bf | 2006-05-19 21:48:03 +0100 | [diff] [blame] | 104 | unsigned int blksz; /* data block size */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | unsigned int blocks; /* number of blocks */ |
| 106 | unsigned int error; /* data error */ |
| 107 | unsigned int flags; |
| 108 | |
| 109 | #define MMC_DATA_WRITE (1 << 8) |
| 110 | #define MMC_DATA_READ (1 << 9) |
| 111 | #define MMC_DATA_STREAM (1 << 10) |
| 112 | |
| 113 | unsigned int bytes_xfered; |
| 114 | |
| 115 | struct mmc_command *stop; /* stop command */ |
Erik Hovland | 8573b80 | 2005-10-28 16:28:04 +0100 | [diff] [blame] | 116 | struct mmc_request *mrq; /* associated request */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 117 | |
| 118 | unsigned int sg_len; /* size of scatter list */ |
| 119 | struct scatterlist *sg; /* I/O scatter list */ |
| 120 | }; |
| 121 | |
| 122 | struct mmc_request { |
Andrei Warkentin | d0c97cf | 2011-05-23 15:06:36 -0500 | [diff] [blame] | 123 | struct mmc_command *sbc; /* SET_BLOCK_COUNT for multiblock */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | struct mmc_command *cmd; |
| 125 | struct mmc_data *data; |
| 126 | struct mmc_command *stop; |
| 127 | |
| 128 | void *done_data; /* completion data */ |
| 129 | void (*done)(struct mmc_request *);/* completion function */ |
| 130 | }; |
| 131 | |
| 132 | struct mmc_host; |
| 133 | struct mmc_card; |
| 134 | |
Pierre Ossman | 67a61c4 | 2007-07-11 20:22:11 +0200 | [diff] [blame] | 135 | extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int); |
John Calixto | cb87ea2 | 2011-04-26 18:56:29 -0400 | [diff] [blame] | 137 | extern int mmc_app_cmd(struct mmc_host *, struct mmc_card *); |
Pierre Ossman | da7fbe5 | 2006-12-24 22:46:55 +0100 | [diff] [blame] | 138 | extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *, |
Pierre Ossman | 335eadf | 2005-09-06 15:18:50 -0700 | [diff] [blame] | 139 | struct mmc_command *, int); |
Andrei Warkentin | d3a8d95 | 2011-04-11 16:13:43 -0500 | [diff] [blame] | 140 | extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | |
Adrian Hunter | dfe86cb | 2010-08-11 14:17:46 -0700 | [diff] [blame] | 142 | #define MMC_ERASE_ARG 0x00000000 |
| 143 | #define MMC_SECURE_ERASE_ARG 0x80000000 |
| 144 | #define MMC_TRIM_ARG 0x00000001 |
| 145 | #define MMC_SECURE_TRIM1_ARG 0x80000001 |
| 146 | #define MMC_SECURE_TRIM2_ARG 0x80008000 |
| 147 | |
| 148 | #define MMC_SECURE_ARGS 0x80000000 |
| 149 | #define MMC_TRIM_ARGS 0x00008001 |
| 150 | |
| 151 | extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr, |
| 152 | unsigned int arg); |
| 153 | extern int mmc_can_erase(struct mmc_card *card); |
| 154 | extern int mmc_can_trim(struct mmc_card *card); |
| 155 | extern int mmc_can_secure_erase_trim(struct mmc_card *card); |
| 156 | extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from, |
| 157 | unsigned int nr); |
| 158 | |
Adrian Hunter | 0f8d8ea | 2010-08-24 13:20:26 +0300 | [diff] [blame] | 159 | extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen); |
| 160 | |
Pierre Ossman | b146d26 | 2007-07-24 19:16:54 +0200 | [diff] [blame] | 161 | extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *); |
Pierre Ossman | ad3868b | 2008-06-28 12:52:45 +0200 | [diff] [blame] | 162 | extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int); |
Russell King | d773d72 | 2006-09-07 15:57:12 +0100 | [diff] [blame] | 163 | |
Nicolas Pitre | 2342f33 | 2007-06-30 16:21:52 +0200 | [diff] [blame] | 164 | extern int __mmc_claim_host(struct mmc_host *host, atomic_t *abort); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | extern void mmc_release_host(struct mmc_host *host); |
Ulf Hansson | ab1efd2 | 2011-03-09 09:11:02 +0100 | [diff] [blame] | 166 | extern void mmc_do_release_host(struct mmc_host *host); |
Adrian Hunter | 319a3f1 | 2009-09-22 16:44:30 -0700 | [diff] [blame] | 167 | extern int mmc_try_claim_host(struct mmc_host *host); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 168 | |
Nicolas Pitre | 2342f33 | 2007-06-30 16:21:52 +0200 | [diff] [blame] | 169 | /** |
| 170 | * mmc_claim_host - exclusively claim a host |
| 171 | * @host: mmc host to claim |
| 172 | * |
| 173 | * Claim a host for a set of operations. |
| 174 | */ |
| 175 | static inline void mmc_claim_host(struct mmc_host *host) |
| 176 | { |
| 177 | __mmc_claim_host(host, NULL); |
| 178 | } |
| 179 | |
Anton Vorontsov | 86e8286 | 2008-11-26 22:54:17 +0300 | [diff] [blame] | 180 | extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max); |
| 181 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | #endif |