xref: /freebsd/sys/dev/mmc/mmc_helpers.h (revision fe6060f10f634930ff71b7c50291ddc610da2475)
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 
28 #ifndef _MMC_HELPERS_H_
29 #define _MMC_HELPERS_H_
30 
31 #include <dev/gpio/gpiobusvar.h>
32 
33 #ifdef EXT_RESOURCES
34 #include <dev/extres/regulator/regulator.h>
35 #endif
36 
37 struct mmc_helper {
38 	device_t		dev;
39 	gpio_pin_t		wp_pin;
40 	gpio_pin_t		cd_pin;
41 	void *			cd_ihandler;
42 	struct resource *	cd_ires;
43 	int			cd_irid;
44 	void			(*cd_handler)(device_t, bool);
45 	struct timeout_task	cd_delayed_task;
46 	bool			cd_disabled;
47 	bool			wp_disabled;
48 	bool			cd_present;
49 	uint32_t		props;
50 #define	MMC_PROP_BROKEN_CD	(1 << 0)
51 #define	MMC_PROP_NON_REMOVABLE	(1 << 1)
52 #define	MMC_PROP_WP_INVERTED	(1 << 2)
53 #define	MMC_PROP_CD_INVERTED	(1 << 3)
54 #define	MMC_PROP_DISABLE_WP	(1 << 4)
55 #define	MMC_PROP_NO_SDIO	(1 << 5)
56 #define	MMC_PROP_NO_SD		(1 << 6)
57 #define	MMC_PROP_NO_MMC		(1 << 7)
58 
59 #ifdef EXT_RESOURCES
60 	regulator_t	vmmc_supply;
61 	regulator_t	vqmmc_supply;
62 #endif
63 
64 	device_t	mmc_pwrseq;
65 };
66 
67 int mmc_parse(device_t dev, struct mmc_helper *helper,
68     struct mmc_host *host);
69 
70 #endif
71