xref: /OK3568_Linux_fs/kernel/drivers/mmc/core/slot-gpio.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Generic GPIO card-detect helper
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2011, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #include <linux/err.h>
9*4882a593Smuzhiyun #include <linux/gpio/consumer.h>
10*4882a593Smuzhiyun #include <linux/interrupt.h>
11*4882a593Smuzhiyun #include <linux/jiffies.h>
12*4882a593Smuzhiyun #include <linux/mmc/host.h>
13*4882a593Smuzhiyun #include <linux/mmc/slot-gpio.h>
14*4882a593Smuzhiyun #include <linux/module.h>
15*4882a593Smuzhiyun #include <linux/slab.h>
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #include <trace/hooks/mmc_core.h>
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun #include "slot-gpio.h"
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun struct mmc_gpio {
22*4882a593Smuzhiyun 	struct gpio_desc *ro_gpio;
23*4882a593Smuzhiyun 	struct gpio_desc *cd_gpio;
24*4882a593Smuzhiyun 	irqreturn_t (*cd_gpio_isr)(int irq, void *dev_id);
25*4882a593Smuzhiyun 	char *ro_label;
26*4882a593Smuzhiyun 	char *cd_label;
27*4882a593Smuzhiyun 	u32 cd_debounce_delay_ms;
28*4882a593Smuzhiyun };
29*4882a593Smuzhiyun 
mmc_gpio_cd_irqt(int irq,void * dev_id)30*4882a593Smuzhiyun static irqreturn_t mmc_gpio_cd_irqt(int irq, void *dev_id)
31*4882a593Smuzhiyun {
32*4882a593Smuzhiyun 	/* Schedule a card detection after a debounce timeout */
33*4882a593Smuzhiyun 	struct mmc_host *host = dev_id;
34*4882a593Smuzhiyun 	struct mmc_gpio *ctx = host->slot.handler_priv;
35*4882a593Smuzhiyun 	bool allow = true;
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun 	trace_android_vh_mmc_gpio_cd_irqt(host, &allow);
38*4882a593Smuzhiyun 	if (!allow)
39*4882a593Smuzhiyun 		return IRQ_HANDLED;
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun 	host->trigger_card_event = true;
42*4882a593Smuzhiyun 	mmc_detect_change(host, msecs_to_jiffies(ctx->cd_debounce_delay_ms));
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun 	return IRQ_HANDLED;
45*4882a593Smuzhiyun }
46*4882a593Smuzhiyun 
mmc_gpio_alloc(struct mmc_host * host)47*4882a593Smuzhiyun int mmc_gpio_alloc(struct mmc_host *host)
48*4882a593Smuzhiyun {
49*4882a593Smuzhiyun 	struct mmc_gpio *ctx = devm_kzalloc(host->parent,
50*4882a593Smuzhiyun 					    sizeof(*ctx), GFP_KERNEL);
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 	if (ctx) {
53*4882a593Smuzhiyun 		ctx->cd_debounce_delay_ms = 200;
54*4882a593Smuzhiyun 		ctx->cd_label = devm_kasprintf(host->parent, GFP_KERNEL,
55*4882a593Smuzhiyun 				"%s cd", dev_name(host->parent));
56*4882a593Smuzhiyun 		if (!ctx->cd_label)
57*4882a593Smuzhiyun 			return -ENOMEM;
58*4882a593Smuzhiyun 		ctx->ro_label = devm_kasprintf(host->parent, GFP_KERNEL,
59*4882a593Smuzhiyun 				"%s ro", dev_name(host->parent));
60*4882a593Smuzhiyun 		if (!ctx->ro_label)
61*4882a593Smuzhiyun 			return -ENOMEM;
62*4882a593Smuzhiyun 		host->slot.handler_priv = ctx;
63*4882a593Smuzhiyun 		host->slot.cd_irq = -EINVAL;
64*4882a593Smuzhiyun 	}
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun 	return ctx ? 0 : -ENOMEM;
67*4882a593Smuzhiyun }
68*4882a593Smuzhiyun 
mmc_gpio_get_ro(struct mmc_host * host)69*4882a593Smuzhiyun int mmc_gpio_get_ro(struct mmc_host *host)
70*4882a593Smuzhiyun {
71*4882a593Smuzhiyun 	struct mmc_gpio *ctx = host->slot.handler_priv;
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun 	if (!ctx || !ctx->ro_gpio)
74*4882a593Smuzhiyun 		return -ENOSYS;
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun 	return gpiod_get_value_cansleep(ctx->ro_gpio);
77*4882a593Smuzhiyun }
78*4882a593Smuzhiyun EXPORT_SYMBOL(mmc_gpio_get_ro);
79*4882a593Smuzhiyun 
mmc_gpio_get_cd(struct mmc_host * host)80*4882a593Smuzhiyun int mmc_gpio_get_cd(struct mmc_host *host)
81*4882a593Smuzhiyun {
82*4882a593Smuzhiyun 	struct mmc_gpio *ctx = host->slot.handler_priv;
83*4882a593Smuzhiyun 	int cansleep;
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun 	if (!ctx || !ctx->cd_gpio)
86*4882a593Smuzhiyun 		return -ENOSYS;
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun 	cansleep = gpiod_cansleep(ctx->cd_gpio);
89*4882a593Smuzhiyun 	return cansleep ?
90*4882a593Smuzhiyun 		gpiod_get_value_cansleep(ctx->cd_gpio) :
91*4882a593Smuzhiyun 		gpiod_get_value(ctx->cd_gpio);
92*4882a593Smuzhiyun }
93*4882a593Smuzhiyun EXPORT_SYMBOL(mmc_gpio_get_cd);
94*4882a593Smuzhiyun 
mmc_gpiod_request_cd_irq(struct mmc_host * host)95*4882a593Smuzhiyun void mmc_gpiod_request_cd_irq(struct mmc_host *host)
96*4882a593Smuzhiyun {
97*4882a593Smuzhiyun 	struct mmc_gpio *ctx = host->slot.handler_priv;
98*4882a593Smuzhiyun 	int irq = -EINVAL;
99*4882a593Smuzhiyun 	int ret;
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun 	if (host->slot.cd_irq >= 0 || !ctx || !ctx->cd_gpio)
102*4882a593Smuzhiyun 		return;
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun 	/*
105*4882a593Smuzhiyun 	 * Do not use IRQ if the platform prefers to poll, e.g., because that
106*4882a593Smuzhiyun 	 * IRQ number is already used by another unit and cannot be shared.
107*4882a593Smuzhiyun 	 */
108*4882a593Smuzhiyun 	if (!(host->caps & MMC_CAP_NEEDS_POLL))
109*4882a593Smuzhiyun 		irq = gpiod_to_irq(ctx->cd_gpio);
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun 	if (irq >= 0) {
112*4882a593Smuzhiyun 		if (!ctx->cd_gpio_isr)
113*4882a593Smuzhiyun 			ctx->cd_gpio_isr = mmc_gpio_cd_irqt;
114*4882a593Smuzhiyun 		ret = devm_request_threaded_irq(host->parent, irq,
115*4882a593Smuzhiyun 			NULL, ctx->cd_gpio_isr,
116*4882a593Smuzhiyun 			IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
117*4882a593Smuzhiyun 			ctx->cd_label, host);
118*4882a593Smuzhiyun 		if (ret < 0)
119*4882a593Smuzhiyun 			irq = ret;
120*4882a593Smuzhiyun 	}
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun 	host->slot.cd_irq = irq;
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun 	if (irq < 0)
125*4882a593Smuzhiyun 		host->caps |= MMC_CAP_NEEDS_POLL;
126*4882a593Smuzhiyun }
127*4882a593Smuzhiyun EXPORT_SYMBOL(mmc_gpiod_request_cd_irq);
128*4882a593Smuzhiyun 
mmc_gpio_set_cd_wake(struct mmc_host * host,bool on)129*4882a593Smuzhiyun int mmc_gpio_set_cd_wake(struct mmc_host *host, bool on)
130*4882a593Smuzhiyun {
131*4882a593Smuzhiyun 	int ret = 0;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	if (!(host->caps & MMC_CAP_CD_WAKE) ||
134*4882a593Smuzhiyun 	    host->slot.cd_irq < 0 ||
135*4882a593Smuzhiyun 	    on == host->slot.cd_wake_enabled)
136*4882a593Smuzhiyun 		return 0;
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 	if (on) {
139*4882a593Smuzhiyun 		ret = enable_irq_wake(host->slot.cd_irq);
140*4882a593Smuzhiyun 		host->slot.cd_wake_enabled = !ret;
141*4882a593Smuzhiyun 	} else {
142*4882a593Smuzhiyun 		disable_irq_wake(host->slot.cd_irq);
143*4882a593Smuzhiyun 		host->slot.cd_wake_enabled = false;
144*4882a593Smuzhiyun 	}
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun 	return ret;
147*4882a593Smuzhiyun }
148*4882a593Smuzhiyun EXPORT_SYMBOL(mmc_gpio_set_cd_wake);
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun /* Register an alternate interrupt service routine for
151*4882a593Smuzhiyun  * the card-detect GPIO.
152*4882a593Smuzhiyun  */
mmc_gpio_set_cd_isr(struct mmc_host * host,irqreturn_t (* isr)(int irq,void * dev_id))153*4882a593Smuzhiyun void mmc_gpio_set_cd_isr(struct mmc_host *host,
154*4882a593Smuzhiyun 			 irqreturn_t (*isr)(int irq, void *dev_id))
155*4882a593Smuzhiyun {
156*4882a593Smuzhiyun 	struct mmc_gpio *ctx = host->slot.handler_priv;
157*4882a593Smuzhiyun 
158*4882a593Smuzhiyun 	WARN_ON(ctx->cd_gpio_isr);
159*4882a593Smuzhiyun 	ctx->cd_gpio_isr = isr;
160*4882a593Smuzhiyun }
161*4882a593Smuzhiyun EXPORT_SYMBOL(mmc_gpio_set_cd_isr);
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun /**
164*4882a593Smuzhiyun  * mmc_gpiod_request_cd - request a gpio descriptor for card-detection
165*4882a593Smuzhiyun  * @host: mmc host
166*4882a593Smuzhiyun  * @con_id: function within the GPIO consumer
167*4882a593Smuzhiyun  * @idx: index of the GPIO to obtain in the consumer
168*4882a593Smuzhiyun  * @override_active_level: ignore %GPIO_ACTIVE_LOW flag
169*4882a593Smuzhiyun  * @debounce: debounce time in microseconds
170*4882a593Smuzhiyun  *
171*4882a593Smuzhiyun  * Note that this must be called prior to mmc_add_host()
172*4882a593Smuzhiyun  * otherwise the caller must also call mmc_gpiod_request_cd_irq().
173*4882a593Smuzhiyun  *
174*4882a593Smuzhiyun  * Returns zero on success, else an error.
175*4882a593Smuzhiyun  */
mmc_gpiod_request_cd(struct mmc_host * host,const char * con_id,unsigned int idx,bool override_active_level,unsigned int debounce)176*4882a593Smuzhiyun int mmc_gpiod_request_cd(struct mmc_host *host, const char *con_id,
177*4882a593Smuzhiyun 			 unsigned int idx, bool override_active_level,
178*4882a593Smuzhiyun 			 unsigned int debounce)
179*4882a593Smuzhiyun {
180*4882a593Smuzhiyun 	struct mmc_gpio *ctx = host->slot.handler_priv;
181*4882a593Smuzhiyun 	struct gpio_desc *desc;
182*4882a593Smuzhiyun 	int ret;
183*4882a593Smuzhiyun 
184*4882a593Smuzhiyun 	desc = devm_gpiod_get_index(host->parent, con_id, idx, GPIOD_IN);
185*4882a593Smuzhiyun 	if (IS_ERR(desc))
186*4882a593Smuzhiyun 		return PTR_ERR(desc);
187*4882a593Smuzhiyun 
188*4882a593Smuzhiyun 	if (debounce) {
189*4882a593Smuzhiyun 		ret = gpiod_set_debounce(desc, debounce);
190*4882a593Smuzhiyun 		if (ret < 0)
191*4882a593Smuzhiyun 			ctx->cd_debounce_delay_ms = debounce / 1000;
192*4882a593Smuzhiyun 	}
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun 	/* override forces default (active-low) polarity ... */
195*4882a593Smuzhiyun 	if (override_active_level && !gpiod_is_active_low(desc))
196*4882a593Smuzhiyun 		gpiod_toggle_active_low(desc);
197*4882a593Smuzhiyun 
198*4882a593Smuzhiyun 	/* ... or active-high */
199*4882a593Smuzhiyun 	if (host->caps2 & MMC_CAP2_CD_ACTIVE_HIGH)
200*4882a593Smuzhiyun 		gpiod_toggle_active_low(desc);
201*4882a593Smuzhiyun 
202*4882a593Smuzhiyun 	ctx->cd_gpio = desc;
203*4882a593Smuzhiyun 
204*4882a593Smuzhiyun 	return 0;
205*4882a593Smuzhiyun }
206*4882a593Smuzhiyun EXPORT_SYMBOL(mmc_gpiod_request_cd);
207*4882a593Smuzhiyun 
mmc_can_gpio_cd(struct mmc_host * host)208*4882a593Smuzhiyun bool mmc_can_gpio_cd(struct mmc_host *host)
209*4882a593Smuzhiyun {
210*4882a593Smuzhiyun 	struct mmc_gpio *ctx = host->slot.handler_priv;
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun 	return ctx->cd_gpio ? true : false;
213*4882a593Smuzhiyun }
214*4882a593Smuzhiyun EXPORT_SYMBOL(mmc_can_gpio_cd);
215*4882a593Smuzhiyun 
216*4882a593Smuzhiyun /**
217*4882a593Smuzhiyun  * mmc_gpiod_request_ro - request a gpio descriptor for write protection
218*4882a593Smuzhiyun  * @host: mmc host
219*4882a593Smuzhiyun  * @con_id: function within the GPIO consumer
220*4882a593Smuzhiyun  * @idx: index of the GPIO to obtain in the consumer
221*4882a593Smuzhiyun  * @debounce: debounce time in microseconds
222*4882a593Smuzhiyun  *
223*4882a593Smuzhiyun  * Returns zero on success, else an error.
224*4882a593Smuzhiyun  */
mmc_gpiod_request_ro(struct mmc_host * host,const char * con_id,unsigned int idx,unsigned int debounce)225*4882a593Smuzhiyun int mmc_gpiod_request_ro(struct mmc_host *host, const char *con_id,
226*4882a593Smuzhiyun 			 unsigned int idx, unsigned int debounce)
227*4882a593Smuzhiyun {
228*4882a593Smuzhiyun 	struct mmc_gpio *ctx = host->slot.handler_priv;
229*4882a593Smuzhiyun 	struct gpio_desc *desc;
230*4882a593Smuzhiyun 	int ret;
231*4882a593Smuzhiyun 
232*4882a593Smuzhiyun 	desc = devm_gpiod_get_index(host->parent, con_id, idx, GPIOD_IN);
233*4882a593Smuzhiyun 	if (IS_ERR(desc))
234*4882a593Smuzhiyun 		return PTR_ERR(desc);
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun 	if (debounce) {
237*4882a593Smuzhiyun 		ret = gpiod_set_debounce(desc, debounce);
238*4882a593Smuzhiyun 		if (ret < 0)
239*4882a593Smuzhiyun 			return ret;
240*4882a593Smuzhiyun 	}
241*4882a593Smuzhiyun 
242*4882a593Smuzhiyun 	if (host->caps2 & MMC_CAP2_RO_ACTIVE_HIGH)
243*4882a593Smuzhiyun 		gpiod_toggle_active_low(desc);
244*4882a593Smuzhiyun 
245*4882a593Smuzhiyun 	ctx->ro_gpio = desc;
246*4882a593Smuzhiyun 
247*4882a593Smuzhiyun 	return 0;
248*4882a593Smuzhiyun }
249*4882a593Smuzhiyun EXPORT_SYMBOL(mmc_gpiod_request_ro);
250*4882a593Smuzhiyun 
mmc_can_gpio_ro(struct mmc_host * host)251*4882a593Smuzhiyun bool mmc_can_gpio_ro(struct mmc_host *host)
252*4882a593Smuzhiyun {
253*4882a593Smuzhiyun 	struct mmc_gpio *ctx = host->slot.handler_priv;
254*4882a593Smuzhiyun 
255*4882a593Smuzhiyun 	return ctx->ro_gpio ? true : false;
256*4882a593Smuzhiyun }
257*4882a593Smuzhiyun EXPORT_SYMBOL(mmc_can_gpio_ro);
258