sys/dev/mmc/mmc_fdt_helpers.h

   1 /*
   2  * Copyright 2019 Emmanuel Vadot <manu@freebsd.org>
   3  * Copyright (c) 2017 Ian Lepore <ian@freebsd.org> All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  *  2. Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE
  19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  22  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef _MMC_FDT_HELPERS_H_
  31 #define _MMC_FDT_HELPERS_H_
  32
  33 #include <dev/gpio/gpiobusvar.h>
  34 #include <dev/ofw/ofw_bus.h>
  35
  36 #ifdef EXT_RESOURCES
  37 #include <dev/extres/regulator/regulator.h>
  38 #endif
  39
  40 struct mmc_fdt_helper {
  41         device_t                dev;
  42         gpio_pin_t              wp_pin;
  43         gpio_pin_t              cd_pin;
  44         void *                  cd_ihandler;
  45         struct resource *       cd_ires;
  46         int                     cd_irid;
  47         void                    (*cd_handler)(device_t, bool);
  48         struct timeout_task     cd_delayed_task;
  49         bool                    cd_disabled;
  50         bool                    wp_disabled;
  51         bool                    cd_present;
  52         uint32_t                props;
  53 #define MMC_PROP_BROKEN_CD      (1 << 0)
  54 #define MMC_PROP_NON_REMOVABLE  (1 << 1)
  55 #define MMC_PROP_WP_INVERTED    (1 << 2)
  56 #define MMC_PROP_CD_INVERTED    (1 << 3)
  57 #define MMC_PROP_DISABLE_WP     (1 << 4)
  58 #define MMC_PROP_NO_SDIO        (1 << 5)
  59 #define MMC_PROP_NO_SD          (1 << 6)
  60 #define MMC_PROP_NO_MMC         (1 << 7)
  61
  62 #ifdef EXT_RESOURCES
  63         regulator_t     vmmc_supply;
  64         regulator_t     vqmmc_supply;
  65 #endif
  66 };
  67
  68 typedef void (*mmc_fdt_cd_handler)(device_t dev, bool present);
  69
  70 int mmc_fdt_parse(device_t dev, phandle_t node, struct mmc_fdt_helper *helper, struct mmc_host *host);
  71 int mmc_fdt_gpio_setup(device_t dev, phandle_t node, struct mmc_fdt_helper *helper, mmc_fdt_cd_handler handler);
  72 void mmc_fdt_gpio_teardown(struct mmc_fdt_helper *helper);
  73 bool mmc_fdt_gpio_get_present(struct mmc_fdt_helper *helper);
  74 bool mmc_fdt_gpio_get_readonly(struct mmc_fdt_helper *helper);
  75
  76 #endif