blob: 86d81cf75b70ad1e2081b8550cfc16acdcf3d212 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Pierre Ossmanaaac1b42007-02-28 15:33:10 +01002 * linux/include/linux/mmc/core.h
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
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 Ossmanaaac1b42007-02-28 15:33:10 +01008#ifndef LINUX_MMC_CORE_H
9#define LINUX_MMC_CORE_H
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/interrupt.h>
12#include <linux/device.h>
13
14struct request;
15struct mmc_data;
16struct mmc_request;
17
18struct mmc_command {
19 u32 opcode;
20 u32 arg;
21 u32 resp[4];
22 unsigned int flags; /* expected response type */
Russell Kinge9225172006-02-02 12:23:12 +000023#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 Brownell97018582007-08-08 09:09:01 -070028
29#define MMC_CMD_MASK (3 << 5) /* non-SPI command type */
Russell Kinge9225172006-02-02 12:23:12 +000030#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 Torvalds1da177e2005-04-16 15:20:36 -070034
David Brownell97018582007-08-08 09:09:01 -070035#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 Torvalds1da177e2005-04-16 15:20:36 -070040/*
David Brownell97018582007-08-08 09:09:01 -070041 * These are the native response types, and correspond to valid bit
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 * patterns of the above flags. One additional valid pattern
43 * is all zeros, which means we don't expect a response.
44 */
Russell Kinge9225172006-02-02 12:23:12 +000045#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 Ossman5c4e6f12007-05-21 20:23:20 +020050#define MMC_RSP_R4 (MMC_RSP_PRESENT)
Pierre Ossmanb2bcc792007-05-22 20:25:21 +020051#define MMC_RSP_R5 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
Philip Langdale6f949902007-01-04 07:04:47 -080052#define MMC_RSP_R6 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
Philip Langdalefba68bd2007-01-04 06:57:32 -080053#define MMC_RSP_R7 (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
Russell Kinge9225172006-02-02 12:23:12 +000054
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 Brownell97018582007-08-08 09:09:01 -070058 * 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 Kinge9225172006-02-02 12:23:12 +000074 * These are the command types.
75 */
Russell King5bd546a2006-02-17 20:23:29 +000076#define mmc_cmd_type(cmd) ((cmd)->flags & MMC_CMD_MASK)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
78 unsigned int retries; /* max number of retries */
79 unsigned int error; /* command error */
80
Pierre Ossman17b04292007-07-22 22:18:46 +020081/*
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 Torvalds1da177e2005-04-16 15:20:36 -070094
Andrei Warkentineaa02f72011-04-11 16:13:41 -050095 unsigned int cmd_timeout_ms; /* in milliseconds */
Adrian Hunterdfe86cb2010-08-11 14:17:46 -070096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 struct mmc_data *data; /* data segment associated with cmd */
Erik Hovland8573b802005-10-28 16:28:04 +010098 struct mmc_request *mrq; /* associated request */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099};
100
101struct mmc_data {
102 unsigned int timeout_ns; /* data timeout (in ns, max 80ms) */
103 unsigned int timeout_clks; /* data timeout (in clocks) */
Pavel Pisa2c171bf2006-05-19 21:48:03 +0100104 unsigned int blksz; /* data block size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 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 Hovland8573b802005-10-28 16:28:04 +0100116 struct mmc_request *mrq; /* associated request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
118 unsigned int sg_len; /* size of scatter list */
119 struct scatterlist *sg; /* I/O scatter list */
120};
121
122struct mmc_request {
Andrei Warkentind0c97cf2011-05-23 15:06:36 -0500123 struct mmc_command *sbc; /* SET_BLOCK_COUNT for multiblock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 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
132struct mmc_host;
133struct mmc_card;
134
Pierre Ossman67a61c42007-07-11 20:22:11 +0200135extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int);
John Calixtocb87ea22011-04-26 18:56:29 -0400137extern int mmc_app_cmd(struct mmc_host *, struct mmc_card *);
Pierre Ossmanda7fbe52006-12-24 22:46:55 +0100138extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *,
Pierre Ossman335eadf2005-09-06 15:18:50 -0700139 struct mmc_command *, int);
Andrei Warkentind3a8d952011-04-11 16:13:43 -0500140extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700142#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
151extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
152 unsigned int arg);
153extern int mmc_can_erase(struct mmc_card *card);
154extern int mmc_can_trim(struct mmc_card *card);
155extern int mmc_can_secure_erase_trim(struct mmc_card *card);
156extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
157 unsigned int nr);
Adrian Huntere056a1b2011-06-28 17:16:02 +0300158extern unsigned int mmc_calc_max_discard(struct mmc_card *card);
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700159
Adrian Hunter0f8d8ea2010-08-24 13:20:26 +0300160extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
161
Pierre Ossmanb146d262007-07-24 19:16:54 +0200162extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *);
Pierre Ossmanad3868b2008-06-28 12:52:45 +0200163extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int);
Russell Kingd773d722006-09-07 15:57:12 +0100164
Nicolas Pitre2342f332007-06-30 16:21:52 +0200165extern int __mmc_claim_host(struct mmc_host *host, atomic_t *abort);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166extern void mmc_release_host(struct mmc_host *host);
Ulf Hanssonab1efd22011-03-09 09:11:02 +0100167extern void mmc_do_release_host(struct mmc_host *host);
Adrian Hunter319a3f12009-09-22 16:44:30 -0700168extern int mmc_try_claim_host(struct mmc_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Nicolas Pitre2342f332007-06-30 16:21:52 +0200170/**
171 * mmc_claim_host - exclusively claim a host
172 * @host: mmc host to claim
173 *
174 * Claim a host for a set of operations.
175 */
176static inline void mmc_claim_host(struct mmc_host *host)
177{
178 __mmc_claim_host(host, NULL);
179}
180
Anton Vorontsov86e82862008-11-26 22:54:17 +0300181extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
182
Robert P. J. Day100e9182011-05-27 16:04:03 -0400183#endif /* LINUX_MMC_CORE_H */