xref: /linux/drivers/mmc/core/queue.h (revision e2683c8868d03382da7e1ce8453b543a043066d1)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef MMC_QUEUE_H
3 #define MMC_QUEUE_H
4 
5 #include <linux/types.h>
6 #include <linux/blkdev.h>
7 #include <linux/blk-mq.h>
8 #include <linux/mmc/core.h>
9 #include <linux/mmc/host.h>
10 
11 enum mmc_issued {
12 	MMC_REQ_STARTED,
13 	MMC_REQ_BUSY,
14 	MMC_REQ_FAILED_TO_START,
15 	MMC_REQ_FINISHED,
16 };
17 
18 enum mmc_issue_type {
19 	MMC_ISSUE_SYNC,
20 	MMC_ISSUE_DCMD,
21 	MMC_ISSUE_ASYNC,
22 	MMC_ISSUE_MAX,
23 };
24 
25 static inline struct mmc_queue_req *req_to_mmc_queue_req(struct request *rq)
26 {
27 	return blk_mq_rq_to_pdu(rq);
28 }
29 
30 struct mmc_queue_req;
31 
32 static inline struct request *mmc_queue_req_to_req(struct mmc_queue_req *mqr)
33 {
34 	return blk_mq_rq_from_pdu(mqr);
35 }
36 
37 struct mmc_blk_data;
38 struct mmc_blk_ioc_data;
39 
40 struct mmc_blk_request {
41 	struct mmc_request	mrq;
42 	struct mmc_command	sbc;
43 	struct mmc_command	cmd;
44 	struct mmc_command	stop;
45 	struct mmc_data		data;
46 };
47 
48 /**
49  * enum mmc_drv_op - enumerates the operations in the mmc_queue_req
50  * @MMC_DRV_OP_IOCTL: ioctl operation
51  * @MMC_DRV_OP_IOCTL_RPMB: RPMB-oriented ioctl operation
52  * @MMC_DRV_OP_BOOT_WP: write protect boot partitions
53  * @MMC_DRV_OP_GET_CARD_STATUS: get card status
54  * @MMC_DRV_OP_GET_EXT_CSD: get the EXT CSD from an eMMC card
55  */
56 enum mmc_drv_op {
57 	MMC_DRV_OP_IOCTL,
58 	MMC_DRV_OP_IOCTL_RPMB,
59 	MMC_DRV_OP_BOOT_WP,
60 	MMC_DRV_OP_GET_CARD_STATUS,
61 	MMC_DRV_OP_GET_EXT_CSD,
62 };
63 
64 #define	MQRQ_XFER_SINGLE_BLOCK		BIT(0)
65 
66 struct mmc_queue_req {
67 	struct mmc_blk_request	brq;
68 	struct scatterlist	*sg;
69 	enum mmc_drv_op		drv_op;
70 	int			drv_op_result;
71 	void			*drv_op_data;
72 	u8			ioc_count;
73 	u8			retries;
74 	u8			flags;
75 };
76 
77 struct mmc_queue {
78 	struct mmc_card		*card;
79 	struct mmc_ctx		ctx;
80 	struct blk_mq_tag_set	tag_set;
81 	struct mmc_blk_data	*blkdata;
82 	struct request_queue	*queue;
83 	spinlock_t		lock;
84 	int			in_flight[MMC_ISSUE_MAX];
85 	unsigned int		cqe_busy;
86 #define MMC_CQE_DCMD_BUSY	BIT(0)
87 	bool			busy;
88 	bool			recovery_needed;
89 	bool			in_recovery;
90 	bool			rw_wait;
91 	bool			waiting;
92 	struct work_struct	recovery_work;
93 	wait_queue_head_t	wait;
94 	struct request		*recovery_req;
95 	struct request		*complete_req;
96 	struct mutex		complete_lock;
97 	struct work_struct	complete_work;
98 };
99 
100 struct gendisk *mmc_init_queue(struct mmc_queue *mq, struct mmc_card *card,
101 		unsigned int features);
102 extern void mmc_cleanup_queue(struct mmc_queue *);
103 extern void mmc_queue_suspend(struct mmc_queue *);
104 extern void mmc_queue_resume(struct mmc_queue *);
105 extern unsigned int mmc_queue_map_sg(struct mmc_queue *,
106 				     struct mmc_queue_req *);
107 
108 void mmc_cqe_check_busy(struct mmc_queue *mq);
109 void mmc_cqe_recovery_notifier(struct mmc_request *mrq);
110 
111 enum mmc_issue_type mmc_issue_type(struct mmc_queue *mq, struct request *req);
112 
113 static inline int mmc_tot_in_flight(struct mmc_queue *mq)
114 {
115 	return mq->in_flight[MMC_ISSUE_SYNC] +
116 	       mq->in_flight[MMC_ISSUE_DCMD] +
117 	       mq->in_flight[MMC_ISSUE_ASYNC];
118 }
119 
120 static inline int mmc_cqe_qcnt(struct mmc_queue *mq)
121 {
122 	return mq->in_flight[MMC_ISSUE_DCMD] +
123 	       mq->in_flight[MMC_ISSUE_ASYNC];
124 }
125 
126 #endif
127