blob: dd2a4b6ab6adb825b5e4f80232cb3707e1ae4103 [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001// SPDX-License-Identifier: GPL-2.0-only
Guennadi Liakhovetskifd0ea652012-04-30 23:31:57 +02002/*
3 * Generic GPIO card-detect helper
4 *
5 * Copyright (C) 2011, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
Guennadi Liakhovetskifd0ea652012-04-30 23:31:57 +02006 */
7
8#include <linux/err.h>
Adrian Hunter842f4bd2014-03-10 15:02:39 +02009#include <linux/gpio/consumer.h>
Guennadi Liakhovetskifd0ea652012-04-30 23:31:57 +020010#include <linux/interrupt.h>
11#include <linux/jiffies.h>
12#include <linux/mmc/host.h>
13#include <linux/mmc/slot-gpio.h>
14#include <linux/module.h>
15#include <linux/slab.h>
16
Ulf Hansson7f133de2014-12-18 15:44:34 +010017#include "slot-gpio.h"
18
Guennadi Liakhovetskifd0ea652012-04-30 23:31:57 +020019struct mmc_gpio {
Adrian Hunter842f4bd2014-03-10 15:02:39 +020020 struct gpio_desc *ro_gpio;
21 struct gpio_desc *cd_gpio;
NeilBrownc7ea8342015-01-13 08:23:18 +130022 irqreturn_t (*cd_gpio_isr)(int irq, void *dev_id);
Guennadi Liakhovetski5aa7dad2012-05-01 16:59:38 +020023 char *ro_label;
Linus Walleijec5af092018-11-12 15:12:30 +010024 char *cd_label;
Shawn Linbfd694d2018-04-24 08:42:57 +080025 u32 cd_debounce_delay_ms;
Guennadi Liakhovetskifd0ea652012-04-30 23:31:57 +020026};
27
28static irqreturn_t mmc_gpio_cd_irqt(int irq, void *dev_id)
29{
30 /* Schedule a card detection after a debounce timeout */
Guennadi Liakhovetski451c8952012-12-04 16:51:36 +010031 struct mmc_host *host = dev_id;
Shawn Linbfd694d2018-04-24 08:42:57 +080032 struct mmc_gpio *ctx = host->slot.handler_priv;
Guennadi Liakhovetski451c8952012-12-04 16:51:36 +010033
Markus Mayerfa372a52014-04-08 15:19:43 -070034 host->trigger_card_event = true;
Shawn Linbfd694d2018-04-24 08:42:57 +080035 mmc_detect_change(host, msecs_to_jiffies(ctx->cd_debounce_delay_ms));
Guennadi Liakhovetski451c8952012-12-04 16:51:36 +010036
Guennadi Liakhovetskifd0ea652012-04-30 23:31:57 +020037 return IRQ_HANDLED;
38}
39
Ulf Hansson7f133de2014-12-18 15:44:34 +010040int mmc_gpio_alloc(struct mmc_host *host)
Guennadi Liakhovetskia7d1a1e2012-05-01 16:51:38 +020041{
Andy Shevchenko4877b812021-09-29 14:17:56 +030042 const char *devname = dev_name(host->parent);
43 struct mmc_gpio *ctx;
Guennadi Liakhovetskia7d1a1e2012-05-01 16:51:38 +020044
Andy Shevchenko4877b812021-09-29 14:17:56 +030045 ctx = devm_kzalloc(host->parent, sizeof(*ctx), GFP_KERNEL);
46 if (!ctx)
47 return -ENOMEM;
Guennadi Liakhovetskia7d1a1e2012-05-01 16:51:38 +020048
Andy Shevchenko4877b812021-09-29 14:17:56 +030049 ctx->cd_debounce_delay_ms = 200;
50 ctx->cd_label = devm_kasprintf(host->parent, GFP_KERNEL, "%s cd", devname);
51 if (!ctx->cd_label)
52 return -ENOMEM;
53 ctx->ro_label = devm_kasprintf(host->parent, GFP_KERNEL, "%s ro", devname);
54 if (!ctx->ro_label)
55 return -ENOMEM;
56 host->slot.handler_priv = ctx;
57 host->slot.cd_irq = -EINVAL;
58
59 return 0;
Guennadi Liakhovetskia7d1a1e2012-05-01 16:51:38 +020060}
61
Guennadi Liakhovetski5aa7dad2012-05-01 16:59:38 +020062int mmc_gpio_get_ro(struct mmc_host *host)
63{
64 struct mmc_gpio *ctx = host->slot.handler_priv;
65
Adrian Hunter842f4bd2014-03-10 15:02:39 +020066 if (!ctx || !ctx->ro_gpio)
Guennadi Liakhovetski5aa7dad2012-05-01 16:59:38 +020067 return -ENOSYS;
68
Adrian Hunter842f4bd2014-03-10 15:02:39 +020069 return gpiod_get_value_cansleep(ctx->ro_gpio);
Guennadi Liakhovetski5aa7dad2012-05-01 16:59:38 +020070}
71EXPORT_SYMBOL(mmc_gpio_get_ro);
72
Guennadi Liakhovetskibefe4042012-05-01 16:27:25 +020073int mmc_gpio_get_cd(struct mmc_host *host)
74{
75 struct mmc_gpio *ctx = host->slot.handler_priv;
Evan Green52af3182018-05-25 12:25:23 -070076 int cansleep;
Guennadi Liakhovetskibefe4042012-05-01 16:27:25 +020077
Adrian Hunter842f4bd2014-03-10 15:02:39 +020078 if (!ctx || !ctx->cd_gpio)
Guennadi Liakhovetskibefe4042012-05-01 16:27:25 +020079 return -ENOSYS;
80
Evan Green52af3182018-05-25 12:25:23 -070081 cansleep = gpiod_cansleep(ctx->cd_gpio);
Evan Green52af3182018-05-25 12:25:23 -070082 return cansleep ?
83 gpiod_get_value_cansleep(ctx->cd_gpio) :
84 gpiod_get_value(ctx->cd_gpio);
Guennadi Liakhovetskibefe4042012-05-01 16:27:25 +020085}
86EXPORT_SYMBOL(mmc_gpio_get_cd);
87
Adrian Hunter740a2212014-03-10 15:02:41 +020088void mmc_gpiod_request_cd_irq(struct mmc_host *host)
Adrian Hunter26652672014-03-10 15:02:40 +020089{
90 struct mmc_gpio *ctx = host->slot.handler_priv;
Masahiro Yamada5f3a8602017-11-08 15:34:54 +090091 int irq = -EINVAL;
92 int ret;
Adrian Hunter26652672014-03-10 15:02:40 +020093
94 if (host->slot.cd_irq >= 0 || !ctx || !ctx->cd_gpio)
95 return;
96
Adrian Hunter26652672014-03-10 15:02:40 +020097 /*
Masahiro Yamada5f3a8602017-11-08 15:34:54 +090098 * Do not use IRQ if the platform prefers to poll, e.g., because that
99 * IRQ number is already used by another unit and cannot be shared.
Adrian Hunter26652672014-03-10 15:02:40 +0200100 */
Masahiro Yamada5f3a8602017-11-08 15:34:54 +0900101 if (!(host->caps & MMC_CAP_NEEDS_POLL))
102 irq = gpiod_to_irq(ctx->cd_gpio);
Adrian Hunter26652672014-03-10 15:02:40 +0200103
104 if (irq >= 0) {
NeilBrownc7ea8342015-01-13 08:23:18 +1300105 if (!ctx->cd_gpio_isr)
106 ctx->cd_gpio_isr = mmc_gpio_cd_irqt;
Ulf Hanssonb4cc5802014-12-18 15:44:33 +0100107 ret = devm_request_threaded_irq(host->parent, irq,
NeilBrownc7ea8342015-01-13 08:23:18 +1300108 NULL, ctx->cd_gpio_isr,
Adrian Hunter26652672014-03-10 15:02:40 +0200109 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
110 ctx->cd_label, host);
111 if (ret < 0)
112 irq = ret;
113 }
114
115 host->slot.cd_irq = irq;
116
117 if (irq < 0)
118 host->caps |= MMC_CAP_NEEDS_POLL;
119}
Adrian Hunter740a2212014-03-10 15:02:41 +0200120EXPORT_SYMBOL(mmc_gpiod_request_cd_irq);
Adrian Hunter26652672014-03-10 15:02:40 +0200121
Adrian Hunter36f1d7e2018-02-27 14:51:25 +0200122int mmc_gpio_set_cd_wake(struct mmc_host *host, bool on)
123{
124 int ret = 0;
125
126 if (!(host->caps & MMC_CAP_CD_WAKE) ||
127 host->slot.cd_irq < 0 ||
128 on == host->slot.cd_wake_enabled)
129 return 0;
130
131 if (on) {
132 ret = enable_irq_wake(host->slot.cd_irq);
133 host->slot.cd_wake_enabled = !ret;
134 } else {
135 disable_irq_wake(host->slot.cd_irq);
136 host->slot.cd_wake_enabled = false;
137 }
138
139 return ret;
140}
141EXPORT_SYMBOL(mmc_gpio_set_cd_wake);
142
NeilBrownc7ea8342015-01-13 08:23:18 +1300143/* Register an alternate interrupt service routine for
144 * the card-detect GPIO.
145 */
146void mmc_gpio_set_cd_isr(struct mmc_host *host,
147 irqreturn_t (*isr)(int irq, void *dev_id))
148{
149 struct mmc_gpio *ctx = host->slot.handler_priv;
150
151 WARN_ON(ctx->cd_gpio_isr);
152 ctx->cd_gpio_isr = isr;
153}
154EXPORT_SYMBOL(mmc_gpio_set_cd_isr);
155
Shawn Guod65b5ae2012-12-11 22:32:18 +0800156/**
Adrian Hunter740a2212014-03-10 15:02:41 +0200157 * mmc_gpiod_request_cd - request a gpio descriptor for card-detection
158 * @host: mmc host
159 * @con_id: function within the GPIO consumer
160 * @idx: index of the GPIO to obtain in the consumer
161 * @override_active_level: ignore %GPIO_ACTIVE_LOW flag
162 * @debounce: debounce time in microseconds
163 *
Linus Walleija622bb02018-12-02 09:43:28 +0100164 * Note that this must be called prior to mmc_add_host()
Adrian Hunter740a2212014-03-10 15:02:41 +0200165 * otherwise the caller must also call mmc_gpiod_request_cd_irq().
166 *
167 * Returns zero on success, else an error.
168 */
169int mmc_gpiod_request_cd(struct mmc_host *host, const char *con_id,
170 unsigned int idx, bool override_active_level,
Michał Mirosławd0052ad2019-12-11 03:40:56 +0100171 unsigned int debounce)
Adrian Hunter740a2212014-03-10 15:02:41 +0200172{
Ulf Hanssondf8aca12014-12-18 15:44:36 +0100173 struct mmc_gpio *ctx = host->slot.handler_priv;
Adrian Hunter740a2212014-03-10 15:02:41 +0200174 struct gpio_desc *desc;
175 int ret;
176
Linus Walleij9fbc6952014-08-27 13:00:50 +0200177 desc = devm_gpiod_get_index(host->parent, con_id, idx, GPIOD_IN);
Adrian Hunter740a2212014-03-10 15:02:41 +0200178 if (IS_ERR(desc))
179 return PTR_ERR(desc);
180
Andy Shevchenko8792b0a2021-09-29 14:17:57 +0300181 /* Update default label if no con_id provided */
182 if (!con_id)
183 gpiod_set_consumer_name(desc, ctx->cd_label);
184
Adrian Hunter740a2212014-03-10 15:02:41 +0200185 if (debounce) {
186 ret = gpiod_set_debounce(desc, debounce);
187 if (ret < 0)
Marek Szyprowski1b09d9c2018-09-28 14:20:40 +0200188 ctx->cd_debounce_delay_ms = debounce / 1000;
Adrian Hunter740a2212014-03-10 15:02:41 +0200189 }
190
Michał Mirosław0f7c8152019-12-11 03:40:56 +0100191 /* override forces default (active-low) polarity ... */
192 if (override_active_level && !gpiod_is_active_low(desc))
193 gpiod_toggle_active_low(desc);
194
195 /* ... or active-high */
196 if (host->caps2 & MMC_CAP2_CD_ACTIVE_HIGH)
197 gpiod_toggle_active_low(desc);
198
Adrian Hunter740a2212014-03-10 15:02:41 +0200199 ctx->cd_gpio = desc;
200
201 return 0;
202}
203EXPORT_SYMBOL(mmc_gpiod_request_cd);
204
Shawn Lin50fcbbb2016-10-12 10:50:37 +0800205bool mmc_can_gpio_cd(struct mmc_host *host)
206{
207 struct mmc_gpio *ctx = host->slot.handler_priv;
208
209 return ctx->cd_gpio ? true : false;
210}
211EXPORT_SYMBOL(mmc_can_gpio_cd);
212
Adrian Hunter740a2212014-03-10 15:02:41 +0200213/**
Linus Walleij9d2fa242014-08-27 13:00:51 +0200214 * mmc_gpiod_request_ro - request a gpio descriptor for write protection
215 * @host: mmc host
216 * @con_id: function within the GPIO consumer
217 * @idx: index of the GPIO to obtain in the consumer
Linus Walleij9d2fa242014-08-27 13:00:51 +0200218 * @debounce: debounce time in microseconds
219 *
Linus Walleij9d2fa242014-08-27 13:00:51 +0200220 * Returns zero on success, else an error.
221 */
222int mmc_gpiod_request_ro(struct mmc_host *host, const char *con_id,
Michał Mirosławd0052ad2019-12-11 03:40:56 +0100223 unsigned int idx, unsigned int debounce)
Linus Walleij9d2fa242014-08-27 13:00:51 +0200224{
Ulf Hanssondf8aca12014-12-18 15:44:36 +0100225 struct mmc_gpio *ctx = host->slot.handler_priv;
Linus Walleij9d2fa242014-08-27 13:00:51 +0200226 struct gpio_desc *desc;
227 int ret;
228
Linus Walleij9d2fa242014-08-27 13:00:51 +0200229 desc = devm_gpiod_get_index(host->parent, con_id, idx, GPIOD_IN);
230 if (IS_ERR(desc))
231 return PTR_ERR(desc);
232
Andy Shevchenko8792b0a2021-09-29 14:17:57 +0300233 /* Update default label if no con_id provided */
234 if (!con_id)
235 gpiod_set_consumer_name(desc, ctx->ro_label);
236
Linus Walleij9d2fa242014-08-27 13:00:51 +0200237 if (debounce) {
238 ret = gpiod_set_debounce(desc, debounce);
239 if (ret < 0)
240 return ret;
241 }
242
Michał Mirosław9073d102019-12-11 03:40:55 +0100243 if (host->caps2 & MMC_CAP2_RO_ACTIVE_HIGH)
244 gpiod_toggle_active_low(desc);
245
Linus Walleij9d2fa242014-08-27 13:00:51 +0200246 ctx->ro_gpio = desc;
247
248 return 0;
249}
250EXPORT_SYMBOL(mmc_gpiod_request_ro);
Masahiro Yamada85f9ef82018-01-18 01:28:05 +0900251
252bool mmc_can_gpio_ro(struct mmc_host *host)
253{
254 struct mmc_gpio *ctx = host->slot.handler_priv;
255
256 return ctx->ro_gpio ? true : false;
257}
258EXPORT_SYMBOL(mmc_can_gpio_ro);