Version:  2.0.40 2.2.26 2.4.37 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9

Linux/drivers/mmc/host/sh_mobile_sdhi.c

  1 /*
  2  * SuperH Mobile SDHI
  3  *
  4  * Copyright (C) 2016 Sang Engineering, Wolfram Sang
  5  * Copyright (C) 2015-16 Renesas Electronics Corporation
  6  * Copyright (C) 2009 Magnus Damm
  7  *
  8  * This program is free software; you can redistribute it and/or modify
  9  * it under the terms of the GNU General Public License version 2 as
 10  * published by the Free Software Foundation.
 11  *
 12  * Based on "Compaq ASIC3 support":
 13  *
 14  * Copyright 2001 Compaq Computer Corporation.
 15  * Copyright 2004-2005 Phil Blundell
 16  * Copyright 2007-2008 OpenedHand Ltd.
 17  *
 18  * Authors: Phil Blundell <pb@handhelds.org>,
 19  *          Samuel Ortiz <sameo@openedhand.com>
 20  *
 21  */
 22 
 23 #include <linux/kernel.h>
 24 #include <linux/clk.h>
 25 #include <linux/slab.h>
 26 #include <linux/mod_devicetable.h>
 27 #include <linux/module.h>
 28 #include <linux/of_device.h>
 29 #include <linux/platform_device.h>
 30 #include <linux/mmc/host.h>
 31 #include <linux/mfd/tmio.h>
 32 #include <linux/sh_dma.h>
 33 #include <linux/delay.h>
 34 #include <linux/pinctrl/consumer.h>
 35 #include <linux/pinctrl/pinctrl-state.h>
 36 #include <linux/regulator/consumer.h>
 37 
 38 #include "tmio_mmc.h"
 39 
 40 #define EXT_ACC           0xe4
 41 
 42 #define SDHI_VER_GEN2_SDR50     0x490c
 43 /* very old datasheets said 0x490c for SDR104, too. They are wrong! */
 44 #define SDHI_VER_GEN2_SDR104    0xcb0d
 45 #define SDHI_VER_GEN3_SD        0xcc10
 46 #define SDHI_VER_GEN3_SDMMC     0xcd10
 47 
 48 #define host_to_priv(host) container_of((host)->pdata, struct sh_mobile_sdhi, mmc_data)
 49 
 50 struct sh_mobile_sdhi_of_data {
 51         unsigned long tmio_flags;
 52         unsigned long capabilities;
 53         unsigned long capabilities2;
 54         enum dma_slave_buswidth dma_buswidth;
 55         dma_addr_t dma_rx_offset;
 56         unsigned bus_shift;
 57 };
 58 
 59 static const struct sh_mobile_sdhi_of_data of_default_cfg = {
 60         .tmio_flags = TMIO_MMC_HAS_IDLE_WAIT,
 61 };
 62 
 63 static const struct sh_mobile_sdhi_of_data of_rcar_gen1_compatible = {
 64         .tmio_flags     = TMIO_MMC_HAS_IDLE_WAIT | TMIO_MMC_WRPROTECT_DISABLE |
 65                           TMIO_MMC_CLK_ACTUAL,
 66         .capabilities   = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ,
 67 };
 68 
 69 static const struct sh_mobile_sdhi_of_data of_rcar_gen2_compatible = {
 70         .tmio_flags     = TMIO_MMC_HAS_IDLE_WAIT | TMIO_MMC_WRPROTECT_DISABLE |
 71                           TMIO_MMC_CLK_ACTUAL | TMIO_MMC_MIN_RCAR2,
 72         .capabilities   = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ,
 73         .dma_buswidth   = DMA_SLAVE_BUSWIDTH_4_BYTES,
 74         .dma_rx_offset  = 0x2000,
 75 };
 76 
 77 static const struct sh_mobile_sdhi_of_data of_rcar_gen3_compatible = {
 78         .tmio_flags     = TMIO_MMC_HAS_IDLE_WAIT | TMIO_MMC_WRPROTECT_DISABLE |
 79                           TMIO_MMC_CLK_ACTUAL | TMIO_MMC_MIN_RCAR2,
 80         .capabilities   = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ,
 81         .bus_shift      = 2,
 82 };
 83 
 84 static const struct of_device_id sh_mobile_sdhi_of_match[] = {
 85         { .compatible = "renesas,sdhi-shmobile" },
 86         { .compatible = "renesas,sdhi-sh73a0", .data = &of_default_cfg, },
 87         { .compatible = "renesas,sdhi-r8a73a4", .data = &of_default_cfg, },
 88         { .compatible = "renesas,sdhi-r8a7740", .data = &of_default_cfg, },
 89         { .compatible = "renesas,sdhi-r8a7778", .data = &of_rcar_gen1_compatible, },
 90         { .compatible = "renesas,sdhi-r8a7779", .data = &of_rcar_gen1_compatible, },
 91         { .compatible = "renesas,sdhi-r8a7790", .data = &of_rcar_gen2_compatible, },
 92         { .compatible = "renesas,sdhi-r8a7791", .data = &of_rcar_gen2_compatible, },
 93         { .compatible = "renesas,sdhi-r8a7792", .data = &of_rcar_gen2_compatible, },
 94         { .compatible = "renesas,sdhi-r8a7793", .data = &of_rcar_gen2_compatible, },
 95         { .compatible = "renesas,sdhi-r8a7794", .data = &of_rcar_gen2_compatible, },
 96         { .compatible = "renesas,sdhi-r8a7795", .data = &of_rcar_gen3_compatible, },
 97         { .compatible = "renesas,sdhi-r8a7796", .data = &of_rcar_gen3_compatible, },
 98         {},
 99 };
100 MODULE_DEVICE_TABLE(of, sh_mobile_sdhi_of_match);
101 
102 struct sh_mobile_sdhi {
103         struct clk *clk;
104         struct tmio_mmc_data mmc_data;
105         struct tmio_mmc_dma dma_priv;
106         struct pinctrl *pinctrl;
107         struct pinctrl_state *pins_default, *pins_uhs;
108 };
109 
110 static void sh_mobile_sdhi_sdbuf_width(struct tmio_mmc_host *host, int width)
111 {
112         u32 val;
113 
114         /*
115          * see also
116          *      sh_mobile_sdhi_of_data :: dma_buswidth
117          */
118         switch (sd_ctrl_read16(host, CTL_VERSION)) {
119         case SDHI_VER_GEN2_SDR50:
120                 val = (width == 32) ? 0x0001 : 0x0000;
121                 break;
122         case SDHI_VER_GEN2_SDR104:
123                 val = (width == 32) ? 0x0000 : 0x0001;
124                 break;
125         case SDHI_VER_GEN3_SD:
126         case SDHI_VER_GEN3_SDMMC:
127                 if (width == 64)
128                         val = 0x0000;
129                 else if (width == 32)
130                         val = 0x0101;
131                 else
132                         val = 0x0001;
133                 break;
134         default:
135                 /* nothing to do */
136                 return;
137         }
138 
139         sd_ctrl_write16(host, EXT_ACC, val);
140 }
141 
142 static int sh_mobile_sdhi_clk_enable(struct tmio_mmc_host *host)
143 {
144         struct mmc_host *mmc = host->mmc;
145         struct sh_mobile_sdhi *priv = host_to_priv(host);
146         int ret = clk_prepare_enable(priv->clk);
147         if (ret < 0)
148                 return ret;
149 
150         /*
151          * The clock driver may not know what maximum frequency
152          * actually works, so it should be set with the max-frequency
153          * property which will already have been read to f_max.  If it
154          * was missing, assume the current frequency is the maximum.
155          */
156         if (!mmc->f_max)
157                 mmc->f_max = clk_get_rate(priv->clk);
158 
159         /*
160          * Minimum frequency is the minimum input clock frequency
161          * divided by our maximum divider.
162          */
163         mmc->f_min = max(clk_round_rate(priv->clk, 1) / 512, 1L);
164 
165         /* enable 16bit data access on SDBUF as default */
166         sh_mobile_sdhi_sdbuf_width(host, 16);
167 
168         return 0;
169 }
170 
171 static unsigned int sh_mobile_sdhi_clk_update(struct tmio_mmc_host *host,
172                                               unsigned int new_clock)
173 {
174         struct sh_mobile_sdhi *priv = host_to_priv(host);
175         unsigned int freq, diff, best_freq = 0, diff_min = ~0;
176         int i, ret;
177 
178         /* tested only on RCar Gen2+ currently; may work for others */
179         if (!(host->pdata->flags & TMIO_MMC_MIN_RCAR2))
180                 return clk_get_rate(priv->clk);
181 
182         /*
183          * We want the bus clock to be as close as possible to, but no
184          * greater than, new_clock.  As we can divide by 1 << i for
185          * any i in [0, 9] we want the input clock to be as close as
186          * possible, but no greater than, new_clock << i.
187          */
188         for (i = min(9, ilog2(UINT_MAX / new_clock)); i >= 0; i--) {
189                 freq = clk_round_rate(priv->clk, new_clock << i);
190                 if (freq > (new_clock << i)) {
191                         /* Too fast; look for a slightly slower option */
192                         freq = clk_round_rate(priv->clk,
193                                               (new_clock << i) / 4 * 3);
194                         if (freq > (new_clock << i))
195                                 continue;
196                 }
197 
198                 diff = new_clock - (freq >> i);
199                 if (diff <= diff_min) {
200                         best_freq = freq;
201                         diff_min = diff;
202                 }
203         }
204 
205         ret = clk_set_rate(priv->clk, best_freq);
206 
207         return ret == 0 ? best_freq : clk_get_rate(priv->clk);
208 }
209 
210 static void sh_mobile_sdhi_clk_disable(struct tmio_mmc_host *host)
211 {
212         struct sh_mobile_sdhi *priv = host_to_priv(host);
213 
214         clk_disable_unprepare(priv->clk);
215 }
216 
217 static int sh_mobile_sdhi_card_busy(struct mmc_host *mmc)
218 {
219         struct tmio_mmc_host *host = mmc_priv(mmc);
220 
221         return !(sd_ctrl_read16_and_16_as_32(host, CTL_STATUS) & TMIO_STAT_DAT0);
222 }
223 
224 static int sh_mobile_sdhi_start_signal_voltage_switch(struct mmc_host *mmc,
225                                                       struct mmc_ios *ios)
226 {
227         struct tmio_mmc_host *host = mmc_priv(mmc);
228         struct sh_mobile_sdhi *priv = host_to_priv(host);
229         struct pinctrl_state *pin_state;
230         int ret;
231 
232         switch (ios->signal_voltage) {
233         case MMC_SIGNAL_VOLTAGE_330:
234                 pin_state = priv->pins_default;
235                 break;
236         case MMC_SIGNAL_VOLTAGE_180:
237                 pin_state = priv->pins_uhs;
238                 break;
239         default:
240                 return -EINVAL;
241         }
242 
243         /*
244          * If anything is missing, assume signal voltage is fixed at
245          * 3.3V and succeed/fail accordingly.
246          */
247         if (IS_ERR(priv->pinctrl) || IS_ERR(pin_state))
248                 return ios->signal_voltage ==
249                         MMC_SIGNAL_VOLTAGE_330 ? 0 : -EINVAL;
250 
251         ret = mmc_regulator_set_vqmmc(host->mmc, ios);
252         if (ret)
253                 return ret;
254 
255         return pinctrl_select_state(priv->pinctrl, pin_state);
256 }
257 
258 static int sh_mobile_sdhi_wait_idle(struct tmio_mmc_host *host)
259 {
260         int timeout = 1000;
261 
262         while (--timeout && !(sd_ctrl_read16_and_16_as_32(host, CTL_STATUS)
263                               & TMIO_STAT_SCLKDIVEN))
264                 udelay(1);
265 
266         if (!timeout) {
267                 dev_warn(&host->pdev->dev, "timeout waiting for SD bus idle\n");
268                 return -EBUSY;
269         }
270 
271         return 0;
272 }
273 
274 static int sh_mobile_sdhi_write16_hook(struct tmio_mmc_host *host, int addr)
275 {
276         switch (addr)
277         {
278         case CTL_SD_CMD:
279         case CTL_STOP_INTERNAL_ACTION:
280         case CTL_XFER_BLK_COUNT:
281         case CTL_SD_CARD_CLK_CTL:
282         case CTL_SD_XFER_LEN:
283         case CTL_SD_MEM_CARD_OPT:
284         case CTL_TRANSACTION_CTL:
285         case CTL_DMA_ENABLE:
286         case EXT_ACC:
287                 return sh_mobile_sdhi_wait_idle(host);
288         }
289 
290         return 0;
291 }
292 
293 static int sh_mobile_sdhi_multi_io_quirk(struct mmc_card *card,
294                                          unsigned int direction, int blk_size)
295 {
296         /*
297          * In Renesas controllers, when performing a
298          * multiple block read of one or two blocks,
299          * depending on the timing with which the
300          * response register is read, the response
301          * value may not be read properly.
302          * Use single block read for this HW bug
303          */
304         if ((direction == MMC_DATA_READ) &&
305             blk_size == 2)
306                 return 1;
307 
308         return blk_size;
309 }
310 
311 static void sh_mobile_sdhi_enable_dma(struct tmio_mmc_host *host, bool enable)
312 {
313         sd_ctrl_write16(host, CTL_DMA_ENABLE, enable ? 2 : 0);
314 
315         /* enable 32bit access if DMA mode if possibile */
316         sh_mobile_sdhi_sdbuf_width(host, enable ? 32 : 16);
317 }
318 
319 static int sh_mobile_sdhi_probe(struct platform_device *pdev)
320 {
321         const struct of_device_id *of_id =
322                 of_match_device(sh_mobile_sdhi_of_match, &pdev->dev);
323         struct sh_mobile_sdhi *priv;
324         struct tmio_mmc_data *mmc_data;
325         struct tmio_mmc_data *mmd = pdev->dev.platform_data;
326         struct tmio_mmc_host *host;
327         struct resource *res;
328         int irq, ret, i = 0;
329         struct tmio_mmc_dma *dma_priv;
330 
331         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
332         if (!res)
333                 return -EINVAL;
334 
335         priv = devm_kzalloc(&pdev->dev, sizeof(struct sh_mobile_sdhi), GFP_KERNEL);
336         if (!priv)
337                 return -ENOMEM;
338 
339         mmc_data = &priv->mmc_data;
340         dma_priv = &priv->dma_priv;
341 
342         priv->clk = devm_clk_get(&pdev->dev, NULL);
343         if (IS_ERR(priv->clk)) {
344                 ret = PTR_ERR(priv->clk);
345                 dev_err(&pdev->dev, "cannot get clock: %d\n", ret);
346                 goto eprobe;
347         }
348 
349         priv->pinctrl = devm_pinctrl_get(&pdev->dev);
350         if (!IS_ERR(priv->pinctrl)) {
351                 priv->pins_default = pinctrl_lookup_state(priv->pinctrl,
352                                                 PINCTRL_STATE_DEFAULT);
353                 priv->pins_uhs = pinctrl_lookup_state(priv->pinctrl,
354                                                 "state_uhs");
355         }
356 
357         host = tmio_mmc_host_alloc(pdev);
358         if (!host) {
359                 ret = -ENOMEM;
360                 goto eprobe;
361         }
362 
363         if (of_id && of_id->data) {
364                 const struct sh_mobile_sdhi_of_data *of_data = of_id->data;
365 
366                 mmc_data->flags |= of_data->tmio_flags;
367                 mmc_data->capabilities |= of_data->capabilities;
368                 mmc_data->capabilities2 |= of_data->capabilities2;
369                 mmc_data->dma_rx_offset = of_data->dma_rx_offset;
370                 dma_priv->dma_buswidth = of_data->dma_buswidth;
371                 host->bus_shift = of_data->bus_shift;
372         }
373 
374         host->dma               = dma_priv;
375         host->write16_hook      = sh_mobile_sdhi_write16_hook;
376         host->clk_enable        = sh_mobile_sdhi_clk_enable;
377         host->clk_update        = sh_mobile_sdhi_clk_update;
378         host->clk_disable       = sh_mobile_sdhi_clk_disable;
379         host->multi_io_quirk    = sh_mobile_sdhi_multi_io_quirk;
380 
381         /* SDR speeds are only available on Gen2+ */
382         if (mmc_data->flags & TMIO_MMC_MIN_RCAR2) {
383                 /* card_busy caused issues on r8a73a4 (pre-Gen2) CD-less SDHI */
384                 host->card_busy = sh_mobile_sdhi_card_busy;
385                 host->start_signal_voltage_switch =
386                         sh_mobile_sdhi_start_signal_voltage_switch;
387         }
388 
389         /* Orginally registers were 16 bit apart, could be 32 or 64 nowadays */
390         if (!host->bus_shift && resource_size(res) > 0x100) /* old way to determine the shift */
391                 host->bus_shift = 1;
392 
393         if (mmd)
394                 *mmc_data = *mmd;
395 
396         dma_priv->filter = shdma_chan_filter;
397         dma_priv->enable = sh_mobile_sdhi_enable_dma;
398 
399         mmc_data->alignment_shift = 1; /* 2-byte alignment */
400         mmc_data->capabilities |= MMC_CAP_MMC_HIGHSPEED;
401 
402         /*
403          * All SDHI blocks support 2-byte and larger block sizes in 4-bit
404          * bus width mode.
405          */
406         mmc_data->flags |= TMIO_MMC_BLKSZ_2BYTES;
407 
408         /*
409          * All SDHI blocks support SDIO IRQ signalling.
410          */
411         mmc_data->flags |= TMIO_MMC_SDIO_IRQ;
412 
413         /*
414          * All SDHI have CMD12 controll bit
415          */
416         mmc_data->flags |= TMIO_MMC_HAVE_CMD12_CTRL;
417 
418         /*
419          * All SDHI need SDIO_INFO1 reserved bit
420          */
421         mmc_data->flags |= TMIO_MMC_SDIO_STATUS_QUIRK;
422 
423         ret = tmio_mmc_host_probe(host, mmc_data);
424         if (ret < 0)
425                 goto efree;
426 
427         while (1) {
428                 irq = platform_get_irq(pdev, i);
429                 if (irq < 0)
430                         break;
431                 i++;
432                 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_irq, 0,
433                                   dev_name(&pdev->dev), host);
434                 if (ret)
435                         goto eirq;
436         }
437 
438         /* There must be at least one IRQ source */
439         if (!i) {
440                 ret = irq;
441                 goto eirq;
442         }
443 
444         dev_info(&pdev->dev, "%s base at 0x%08lx max clock rate %u MHz\n",
445                  mmc_hostname(host->mmc), (unsigned long)
446                  (platform_get_resource(pdev, IORESOURCE_MEM, 0)->start),
447                  host->mmc->f_max / 1000000);
448 
449         return ret;
450 
451 eirq:
452         tmio_mmc_host_remove(host);
453 efree:
454         tmio_mmc_host_free(host);
455 eprobe:
456         return ret;
457 }
458 
459 static int sh_mobile_sdhi_remove(struct platform_device *pdev)
460 {
461         struct mmc_host *mmc = platform_get_drvdata(pdev);
462         struct tmio_mmc_host *host = mmc_priv(mmc);
463 
464         tmio_mmc_host_remove(host);
465 
466         return 0;
467 }
468 
469 static const struct dev_pm_ops tmio_mmc_dev_pm_ops = {
470         SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
471                         pm_runtime_force_resume)
472         SET_RUNTIME_PM_OPS(tmio_mmc_host_runtime_suspend,
473                         tmio_mmc_host_runtime_resume,
474                         NULL)
475 };
476 
477 static struct platform_driver sh_mobile_sdhi_driver = {
478         .driver         = {
479                 .name   = "sh_mobile_sdhi",
480                 .pm     = &tmio_mmc_dev_pm_ops,
481                 .of_match_table = sh_mobile_sdhi_of_match,
482         },
483         .probe          = sh_mobile_sdhi_probe,
484         .remove         = sh_mobile_sdhi_remove,
485 };
486 
487 module_platform_driver(sh_mobile_sdhi_driver);
488 
489 MODULE_DESCRIPTION("SuperH Mobile SDHI driver");
490 MODULE_AUTHOR("Magnus Damm");
491 MODULE_LICENSE("GPL v2");
492 MODULE_ALIAS("platform:sh_mobile_sdhi");
493 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us