include/linux/mmc/core.h - kernel/msm-4.19 - Gitiles

 /*
  *  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;

 struct mmc_command {
 	u32			opcode;
 	u32			arg;
 	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)

 #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 */
 	unsigned 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		cmd_timeout_ms;	/* in milliseconds */

 	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 */
 	unsigned int		error;		/* data error */
 	unsigned int		flags;

 #define MMC_DATA_WRITE	(1 << 8)
 #define MMC_DATA_READ	(1 << 9)
 #define MMC_DATA_STREAM	(1 << 10)

 	unsigned int		bytes_xfered;

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

 	unsigned int		sg_len;		/* size of scatter list */
 	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;
 	void			(*done)(struct mmc_request *);/* completion function */
 	struct mmc_host		*host;
 };

 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 *, int *);
 extern int mmc_interrupt_hpi(struct mmc_card *);
 extern void mmc_wait_for_req(struct mmc_host *, struct mmc_request *);
 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, bool);
 extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int);

 #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_hw_reset_check(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 int mmc_try_claim_host(struct mmc_host *host);

 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);
 }

 extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);

 #endif /* 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;

	struct mmc_command {
	u32 opcode;
	u32 arg;
	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)

	#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 */
	unsigned 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 cmd_timeout_ms; /* in milliseconds */

	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 */
	unsigned int error; /* data error */
	unsigned int flags;

	#define MMC_DATA_WRITE (1 << 8)
	#define MMC_DATA_READ (1 << 9)
	#define MMC_DATA_STREAM (1 << 10)

	unsigned int bytes_xfered;

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

	unsigned int sg_len; /* size of scatter list */
	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;
	void (done)(struct mmc_request );/* completion function */
	struct mmc_host *host;
	};

	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 , int );
	extern int mmc_interrupt_hpi(struct mmc_card *);
	extern void mmc_wait_for_req(struct mmc_host , struct mmc_request );
	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, bool);
	extern int mmc_switch(struct mmc_card *, u8, u8, u8, unsigned int);

	#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_hw_reset_check(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 int mmc_try_claim_host(struct mmc_host *host);

	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);
	}

	extern u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);

	#endif /* LINUX_MMC_CORE_H */