core.h

  1/* SPDX-License-Identifier: GPL-2.0-only */
  2/*
  3 *  linux/include/linux/mmc/core.h
  4 */
  5#ifndef LINUX_MMC_CORE_H
  6#define LINUX_MMC_CORE_H
  7
  8#include <linux/completion.h>
  9#include <linux/types.h>
 10
 11struct mmc_data;
 12struct mmc_request;
 13
 14#define UHS2_MAX_PAYLOAD_LEN 2
 15#define UHS2_MAX_RESP_LEN 20
 16
 17struct uhs2_command {
 18	u16	header;
 19	u16	arg;
 20	__be32	payload[UHS2_MAX_PAYLOAD_LEN];
 21	u8	payload_len;
 22	u8	packet_len;
 23	u8	tmode_half_duplex;
 24	u8	uhs2_resp[UHS2_MAX_RESP_LEN];	/* UHS2 native cmd resp */
 25	u8	uhs2_resp_len;			/* UHS2 native cmd resp len */
 26};
 27
 28struct mmc_command {
 29	u32			opcode;
 30	u32			arg;
 31#define MMC_CMD23_ARG_REL_WR	(1 << 31)
 32#define MMC_CMD23_ARG_TAG_REQ	(1 << 29)
 33	u32			resp[4];
 34	unsigned int		flags;		/* expected response type */
 35#define MMC_RSP_PRESENT	(1 << 0)
 36#define MMC_RSP_136	(1 << 1)		/* 136 bit response */
 37#define MMC_RSP_CRC	(1 << 2)		/* expect valid crc */
 38#define MMC_RSP_BUSY	(1 << 3)		/* card may send busy */
 39#define MMC_RSP_OPCODE	(1 << 4)		/* response contains opcode */
 40
 41#define MMC_CMD_MASK	(3 << 5)		/* non-SPI command type */
 42#define MMC_CMD_AC	(0 << 5)
 43#define MMC_CMD_ADTC	(1 << 5)
 44#define MMC_CMD_BC	(2 << 5)
 45#define MMC_CMD_BCR	(3 << 5)
 46
 47#define MMC_RSP_SPI_S1	(1 << 7)		/* one status byte */
 48#define MMC_RSP_SPI_S2	(1 << 8)		/* second byte */
 49#define MMC_RSP_SPI_B4	(1 << 9)		/* four data bytes */
 50#define MMC_RSP_SPI_BUSY (1 << 10)		/* card may send busy */
 51
 52/*
 53 * These are the native response types, and correspond to valid bit
 54 * patterns of the above flags.  One additional valid pattern
 55 * is all zeros, which means we don't expect a response.
 56 */
 57#define MMC_RSP_NONE	(0)
 58#define MMC_RSP_R1	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
 59#define MMC_RSP_R1B	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE|MMC_RSP_BUSY)
 60#define MMC_RSP_R1B_NO_CRC (MMC_RSP_PRESENT|MMC_RSP_OPCODE|MMC_RSP_BUSY)
 61#define MMC_RSP_R2	(MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
 62#define MMC_RSP_R3	(MMC_RSP_PRESENT)
 63#define MMC_RSP_R4	(MMC_RSP_PRESENT)
 64#define MMC_RSP_R5	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
 65#define MMC_RSP_R6	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
 66#define MMC_RSP_R7	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
 67
 68#define mmc_resp_type(cmd)	((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE))
 69
 70/*
 71 * These are the SPI response types for MMC, SD, and SDIO cards.
 72 * Commands return R1, with maybe more info.  Zero is an error type;
 73 * callers must always provide the appropriate MMC_RSP_SPI_Rx flags.
 74 */
 75#define MMC_RSP_SPI_R1	(MMC_RSP_SPI_S1)
 76#define MMC_RSP_SPI_R1B	(MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY)
 77#define MMC_RSP_SPI_R2	(MMC_RSP_SPI_S1|MMC_RSP_SPI_S2)
 78#define MMC_RSP_SPI_R3	(MMC_RSP_SPI_S1|MMC_RSP_SPI_B4)
 79#define MMC_RSP_SPI_R4	(MMC_RSP_SPI_S1|MMC_RSP_SPI_B4)
 80#define MMC_RSP_SPI_R5	(MMC_RSP_SPI_S1|MMC_RSP_SPI_S2)
 81#define MMC_RSP_SPI_R7	(MMC_RSP_SPI_S1|MMC_RSP_SPI_B4)
 82
 83#define mmc_spi_resp_type(cmd)	((cmd)->flags & \
 84		(MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY|MMC_RSP_SPI_S2|MMC_RSP_SPI_B4))
 85
 86/*
 87 * These are the command types.
 88 */
 89#define mmc_cmd_type(cmd)	((cmd)->flags & MMC_CMD_MASK)
 90
 91	unsigned int		retries;	/* max number of retries */
 92	int			error;		/* command error */
 93
 94/*
 95 * Standard errno values are used for errors, but some have specific
 96 * meaning in the MMC layer:
 97 *
 98 * ETIMEDOUT    Card took too long to respond
 99 * EILSEQ       Basic format problem with the received or sent data
100 *              (e.g. CRC check failed, incorrect opcode in response
101 *              or bad end bit)
102 * EINVAL       Request cannot be performed because of restrictions
103 *              in hardware and/or the driver
104 * ENOMEDIUM    Host can determine that the slot is empty and is
105 *              actively failing requests
106 */
107
108	unsigned int		busy_timeout;	/* busy detect timeout in ms */
109	struct mmc_data		*data;		/* data segment associated with cmd */
110	struct mmc_request	*mrq;		/* associated request */
111
112	struct uhs2_command	*uhs2_cmd;	/* UHS2 command */
113
114	/* for SDUC */
115	bool has_ext_addr;
116	u8 ext_addr;
117};
118
119struct mmc_data {
120	unsigned int		timeout_ns;	/* data timeout (in ns, max 80ms) */
121	unsigned int		timeout_clks;	/* data timeout (in clocks) */
122	unsigned int		blksz;		/* data block size */
123	unsigned int		blocks;		/* number of blocks */
124	unsigned int		blk_addr;	/* block address */
125	int			error;		/* data error */
126	unsigned int		flags;
127
128#define MMC_DATA_WRITE		BIT(8)
129#define MMC_DATA_READ		BIT(9)
130/* Extra flags used by CQE */
131#define MMC_DATA_QBR		BIT(10)		/* CQE queue barrier*/
132#define MMC_DATA_PRIO		BIT(11)		/* CQE high priority */
133#define MMC_DATA_REL_WR		BIT(12)		/* Reliable write */
134#define MMC_DATA_DAT_TAG	BIT(13)		/* Tag request */
135#define MMC_DATA_FORCED_PRG	BIT(14)		/* Forced programming */
136
137	unsigned int		bytes_xfered;
138
139	struct mmc_command	*stop;		/* stop command */
140	struct mmc_request	*mrq;		/* associated request */
141
142	unsigned int		sg_len;		/* size of scatter list */
143	int			sg_count;	/* mapped sg entries */
144	struct scatterlist	*sg;		/* I/O scatter list */
145	s32			host_cookie;	/* host private data */
146};
147
148struct mmc_host;
149struct mmc_request {
150	struct mmc_command	*sbc;		/* SET_BLOCK_COUNT for multiblock */
151	struct mmc_command	*cmd;
152	struct mmc_data		*data;
153	struct mmc_command	*stop;
154
155	struct completion	completion;
156	struct completion	cmd_completion;
157	void			(*done)(struct mmc_request *);/* completion function */
158	/*
159	 * Notify uppers layers (e.g. mmc block driver) that recovery is needed
160	 * due to an error associated with the mmc_request. Currently used only
161	 * by CQE.
162	 */
163	void			(*recovery_notifier)(struct mmc_request *);
164	struct mmc_host		*host;
165
166	/* Allow other commands during this ongoing data transfer or busy wait */
167	bool			cap_cmd_during_tfr;
168
169	int			tag;
170
171#ifdef CONFIG_MMC_CRYPTO
172	const struct bio_crypt_ctx *crypto_ctx;
173	int			crypto_key_slot;
174#endif
175	struct uhs2_command	uhs2_cmd;
176};
177
178struct mmc_card;
179
180void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq);
181int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd,
182		int retries);
183
184int mmc_hw_reset(struct mmc_card *card);
185int mmc_sw_reset(struct mmc_card *card);
186void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card);
187
188#endif /* LINUX_MMC_CORE_H */