Release 4.10 include/linux/mmc/core.h

/*
 *  linux/include/linux/mmc/core.h
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef LINUX_MMC_CORE_H

#define LINUX_MMC_CORE_H

#include <linux/interrupt.h>
#include <linux/completion.h>

struct request;
struct mmc_data;
struct mmc_request;


enum mmc_blk_status {
	
MMC_BLK_SUCCESS = 0,
	
MMC_BLK_PARTIAL,
	
MMC_BLK_CMD_ERR,
	
MMC_BLK_RETRY,
	
MMC_BLK_ABORT,
	
MMC_BLK_DATA_ERR,
	
MMC_BLK_ECC_ERR,
	
MMC_BLK_NOMEDIUM,
	
MMC_BLK_NEW_REQUEST,
};


struct mmc_command {
	
u32			opcode;
	
u32			arg;

#define MMC_CMD23_ARG_REL_WR	(1 << 31)

#define MMC_CMD23_ARG_PACKED	((0 << 31) | (1 << 30))

#define MMC_CMD23_ARG_TAG_REQ	(1 << 29)
	
u32			resp[4];
	
unsigned int		flags;		/* expected response type */

#define MMC_RSP_PRESENT	(1 << 0)

#define MMC_RSP_136	(1 << 1)		/* 136 bit response */

#define MMC_RSP_CRC	(1 << 2)		/* expect valid crc */

#define MMC_RSP_BUSY	(1 << 3)		/* card may send busy */

#define MMC_RSP_OPCODE	(1 << 4)		/* response contains opcode */


#define MMC_CMD_MASK	(3 << 5)		/* non-SPI command type */

#define MMC_CMD_AC	(0 << 5)

#define MMC_CMD_ADTC	(1 << 5)

#define MMC_CMD_BC	(2 << 5)

#define MMC_CMD_BCR	(3 << 5)


#define MMC_RSP_SPI_S1	(1 << 7)		/* one status byte */

#define MMC_RSP_SPI_S2	(1 << 8)		/* second byte */

#define MMC_RSP_SPI_B4	(1 << 9)		/* four data bytes */

#define MMC_RSP_SPI_BUSY (1 << 10)		/* card may send busy */

/*
 * These are the native response types, and correspond to valid bit
 * patterns of the above flags.  One additional valid pattern
 * is all zeros, which means we don't expect a response.
 */

#define MMC_RSP_NONE	(0)

#define MMC_RSP_R1	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)

#define MMC_RSP_R1B	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE|MMC_RSP_BUSY)

#define MMC_RSP_R2	(MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)

#define MMC_RSP_R3	(MMC_RSP_PRESENT)

#define MMC_RSP_R4	(MMC_RSP_PRESENT)

#define MMC_RSP_R5	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)

#define MMC_RSP_R6	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)

#define MMC_RSP_R7	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)

/* Can be used by core to poll after switch to MMC HS mode */

#define MMC_RSP_R1_NO_CRC	(MMC_RSP_PRESENT|MMC_RSP_OPCODE)


#define mmc_resp_type(cmd)	((cmd)->flags & (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC|MMC_RSP_BUSY|MMC_RSP_OPCODE))

/*
 * These are the SPI response types for MMC, SD, and SDIO cards.
 * Commands return R1, with maybe more info.  Zero is an error type;
 * callers must always provide the appropriate MMC_RSP_SPI_Rx flags.
 */

#define MMC_RSP_SPI_R1	(MMC_RSP_SPI_S1)

#define MMC_RSP_SPI_R1B	(MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY)

#define MMC_RSP_SPI_R2	(MMC_RSP_SPI_S1|MMC_RSP_SPI_S2)

#define MMC_RSP_SPI_R3	(MMC_RSP_SPI_S1|MMC_RSP_SPI_B4)

#define MMC_RSP_SPI_R4	(MMC_RSP_SPI_S1|MMC_RSP_SPI_B4)

#define MMC_RSP_SPI_R5	(MMC_RSP_SPI_S1|MMC_RSP_SPI_S2)

#define MMC_RSP_SPI_R7	(MMC_RSP_SPI_S1|MMC_RSP_SPI_B4)


#define mmc_spi_resp_type(cmd)	((cmd)->flags & \
                (MMC_RSP_SPI_S1|MMC_RSP_SPI_BUSY|MMC_RSP_SPI_S2|MMC_RSP_SPI_B4))

/*
 * These are the command types.
 */

#define mmc_cmd_type(cmd)	((cmd)->flags & MMC_CMD_MASK)

	
unsigned int		retries;	/* max number of retries */
	
int			error;		/* command error */

/*
 * Standard errno values are used for errors, but some have specific
 * meaning in the MMC layer:
 *
 * ETIMEDOUT    Card took too long to respond
 * EILSEQ       Basic format problem with the received or sent data
 *              (e.g. CRC check failed, incorrect opcode in response
 *              or bad end bit)
 * EINVAL       Request cannot be performed because of restrictions
 *              in hardware and/or the driver
 * ENOMEDIUM    Host can determine that the slot is empty and is
 *              actively failing requests
 */

	
unsigned int		busy_timeout;	/* busy detect timeout in ms */
	/* Set this flag only for blocking sanitize request */
	
bool			sanitize_busy;

	
struct mmc_data		*data;		/* data segment associated with cmd */
	
struct mmc_request	*mrq;		/* associated request */
};


struct mmc_data {
	
unsigned int		timeout_ns;	/* data timeout (in ns, max 80ms) */
	
unsigned int		timeout_clks;	/* data timeout (in clocks) */
	
unsigned int		blksz;		/* data block size */
	
unsigned int		blocks;		/* number of blocks */
	
int			error;		/* data error */
	
unsigned int		flags;


#define MMC_DATA_WRITE	(1 << 8)

#define MMC_DATA_READ	(1 << 9)

	
unsigned int		bytes_xfered;

	
struct mmc_command	*stop;		/* stop command */
	
struct mmc_request	*mrq;		/* associated request */

	
unsigned int		sg_len;		/* size of scatter list */
	
int			sg_count;	/* mapped sg entries */
	
struct scatterlist	*sg;		/* I/O scatter list */
	
s32			host_cookie;	/* host private data */
};

struct mmc_host;

struct mmc_request {
	
struct mmc_command	*sbc;		/* SET_BLOCK_COUNT for multiblock */
	
struct mmc_command	*cmd;
	
struct mmc_data		*data;
	
struct mmc_command	*stop;

	
struct completion	completion;
	
struct completion	cmd_completion;
	
void			(*done)(struct mmc_request *);/* completion function */
	
struct mmc_host		*host;

	/* Allow other commands during this ongoing data transfer or busy wait */
	
bool			cap_cmd_during_tfr;
};

struct mmc_card;
struct mmc_async_req;

extern int mmc_stop_bkops(struct mmc_card *);
extern int mmc_read_bkops_status(struct mmc_card *);
extern struct mmc_async_req *mmc_start_req(struct mmc_host *,
					   struct mmc_async_req *,
					   enum mmc_blk_status *);
extern int mmc_interrupt_hpi(struct mmc_card *);
extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
extern void mmc_wait_for_req_done(struct mmc_host *host,
				  struct mmc_request *mrq);
extern bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq);
extern int mmc_wait_for_cmd(struct mmc_host *, struct mmc_command *, int);
extern int mmc_app_cmd(struct mmc_host *, struct mmc_card *);
extern int mmc_wait_for_app_cmd(struct mmc_host *, struct mmc_card *,
	struct mmc_command *, int);
extern void mmc_start_bkops(struct mmc_card *card, bool from_exception);
extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int);
extern int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error);
extern int mmc_abort_tuning(struct mmc_host *host, u32 opcode);
extern int mmc_get_ext_csd(struct mmc_card *card, u8 **new_ext_csd);


#define MMC_ERASE_ARG		0x00000000

#define MMC_SECURE_ERASE_ARG	0x80000000

#define MMC_TRIM_ARG		0x00000001

#define MMC_DISCARD_ARG		0x00000003

#define MMC_SECURE_TRIM1_ARG	0x80000001

#define MMC_SECURE_TRIM2_ARG	0x80008000


#define MMC_SECURE_ARGS		0x80000000

#define MMC_TRIM_ARGS		0x00008001

extern int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
		     unsigned int arg);
extern int mmc_can_erase(struct mmc_card *card);
extern int mmc_can_trim(struct mmc_card *card);
extern int mmc_can_discard(struct mmc_card *card);
extern int mmc_can_sanitize(struct mmc_card *card);
extern int mmc_can_secure_erase_trim(struct mmc_card *card);
extern int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
				   unsigned int nr);
extern unsigned int mmc_calc_max_discard(struct mmc_card *card);

extern int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
extern int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
			      bool is_rel_write);
extern int mmc_hw_reset(struct mmc_host *host);
extern int mmc_can_reset(struct mmc_card *card);

extern void mmc_set_data_timeout(struct mmc_data *, const struct mmc_card *);
extern unsigned int mmc_align_data_size(struct mmc_card *, unsigned int);

extern int __mmc_claim_host(struct mmc_host *host, atomic_t *abort);
extern void mmc_release_host(struct mmc_host *host);

extern void mmc_get_card(struct mmc_card *card);
extern void mmc_put_card(struct mmc_card *card);

extern int mmc_flush_cache(struct mmc_card *);

extern int mmc_detect_card_removed(struct mmc_host *host);

/**
 *      mmc_claim_host - exclusively claim a host
 *      @host: mmc host to claim
 *
 *      Claim a host for a set of operations.
 */


static inline void mmc_claim_host(struct mmc_host *host)
{
	__mmc_claim_host(host, NULL);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
nicolas pitre
nicolas pitre
19
100.00%
1
100.00%
Total
19
100.00%
1
100.00%

struct device_node;
extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
extern int mmc_of_parse_voltage(struct device_node *np, u32 *mask);

#endif /* LINUX_MMC_CORE_H */
Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
russell king
russell king
291
30.76%
8
13.79%
adrian hunter
adrian hunter
207
21.88%
7
12.07%
david brownell
david brownell
58
6.13%
1
1.72%
pierre ossman
pierre ossman
49
5.18%
10
17.24%
ulf hansson
ulf hansson
44
4.65%
5
8.62%
jaehoon chung
jaehoon chung
41
4.33%
2
3.45%
per forlin
per forlin
27
2.85%
1
1.72%
nicolas pitre
nicolas pitre
26
2.75%
1
1.72%
linus walleij
linus walleij
26
2.75%
1
1.72%
kyungmin park
kyungmin park
24
2.54%
2
3.45%
andrei warkentin
andrei warkentin
23
2.43%
2
3.45%
seungwon jeon
seungwon jeon
22
2.33%
2
3.45%
haijun zhang
haijun zhang
17
1.80%
1
1.72%
loic pallardy
loic pallardy
17
1.80%
1
1.72%
john calixto
john calixto
13
1.37%
1
1.72%
chaotian jing
chaotian jing
11
1.16%
2
3.45%
anton vorontsov
anton vorontsov
11
1.16%
1
1.72%
konstantin dorfman
konstantin dorfman
8
0.85%
1
1.72%
minda chen
minda chen
8
0.85%
1
1.72%
philip langdale
philip langdale
5
0.53%
2
3.45%
pavel pisa
pavel pisa
5
0.53%
1
1.72%
wolfram sang
wolfram sang
5
0.53%
1
1.72%
maya erez
maya erez
4
0.42%
1
1.72%
erik hovland
erik hovland
2
0.21%
1
1.72%
robert p. j. day
robert p. j. day
1
0.11%
1
1.72%
paul gortmaker
paul gortmaker
1
0.11%
1
1.72%
Total
946
100.00%
58
100.00%
Directory: include/linux/mmc

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.