bridge.h revision 322388
187189Spdeuskar/*- 287189Spdeuskar * Copyright (c) 2006 M. Warner Losh. All rights reserved. 3176667Sjfv * 487189Spdeuskar * Redistribution and use in source and binary forms, with or without 587189Spdeuskar * modification, are permitted provided that the following conditions 6103895Spdeuskar * are met: 7103895Spdeuskar * 1. Redistributions of source code must retain the above copyright 887189Spdeuskar * notice, this list of conditions and the following disclaimer. 9103895Spdeuskar * 2. Redistributions in binary form must reproduce the above copyright 10103895Spdeuskar * notice, this list of conditions and the following disclaimer in the 1187189Spdeuskar * documentation and/or other materials provided with the distribution. 12103895Spdeuskar * 13103895Spdeuskar * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 14103895Spdeuskar * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 1587189Spdeuskar * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 1687189Spdeuskar * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 17103895Spdeuskar * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 18103895Spdeuskar * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1987189Spdeuskar * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2087189Spdeuskar * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2187189Spdeuskar * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2287189Spdeuskar * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23103895Spdeuskar * 24103895Spdeuskar * Portions of this software may have been developed with reference to 25103895Spdeuskar * the SD Simplified Specification. The following disclaimer may apply: 26103895Spdeuskar * 27103895Spdeuskar * The following conditions apply to the release of the simplified 28103895Spdeuskar * specification ("Simplified Specification") by the SD Card Association and 29103895Spdeuskar * the SD Group. The Simplified Specification is a subset of the complete SD 30103895Spdeuskar * Specification which is owned by the SD Card Association and the SD 3187189Spdeuskar * Group. This Simplified Specification is provided on a non-confidential 3287189Spdeuskar * basis subject to the disclaimers below. Any implementation of the 33176667Sjfv * Simplified Specification may require a license from the SD Card 34163730Sjfv * Association, SD Group, SD-3C LLC or other third parties. 3587189Spdeuskar * 3687189Spdeuskar * Disclaimers: 3787189Spdeuskar * 38108229Spdeuskar * The information contained in the Simplified Specification is presented only 39108229Spdeuskar * as a standard specification for SD Cards and SD Host/Ancillary products and 40108229Spdeuskar * is provided "AS-IS" without any representations or warranties of any 41152276Sglebius * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD 42106649Spdeuskar * Card Association for any damages, any infringements of patents or other 43115878Spdeuskar * right of the SD Group, SD-3C LLC, the SD Card Association or any third 44106649Spdeuskar * parties, which may result from its use. No license is granted by 45106649Spdeuskar * implication, estoppel or otherwise under any patent or other rights of the 46106649Spdeuskar * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing 47108229Spdeuskar * herein shall be construed as an obligation by the SD Group, the SD-3C LLC 48152645Syongari * or the SD Card Association to disclose or distribute any technical 49152645Syongari * information, know-how or other confidential information to any third party. 50169240Sjfv * 51108229Spdeuskar * $FreeBSD: stable/11/sys/dev/mmc/bridge.h 322388 2017-08-11 00:41:19Z marius $ 52152545Sglebius */ 53152545Sglebius 54152545Sglebius#ifndef DEV_MMC_BRIDGE_H 55152545Sglebius#define DEV_MMC_BRIDGE_H 56106649Spdeuskar 57106649Spdeuskar#include <sys/bus.h> 58152276Sglebius 59106649Spdeuskar/* 60115878Spdeuskar * This file defines interfaces for the mmc bridge. The names chosen 61108229Spdeuskar * are similar to or the same as the names used in Linux to allow for 62106649Spdeuskar * easy porting of what Linux calls mmc host drivers. I use the 63106649Spdeuskar * FreeBSD terminology of bridge and bus for consistency with other 64106649Spdeuskar * drivers in the system. This file corresponds roughly to the Linux 65106649Spdeuskar * linux/mmc/host.h file. 66152645Syongari * 67152645Syongari * A mmc bridge is a chipset that can have one or more mmc and/or sd 68169240Sjfv * cards attached to it. mmc devices are attached on a bus topology, 69106649Spdeuskar * while sd and sdio cards usually are attached using a star topology 70152545Sglebius * (meaning in practice each sd card has its own, independent slot). 71152545Sglebius * Since SDHCI v3.00, buses for esd and esdio are possible, though. 72152545Sglebius * 73169240Sjfv * Attached to the mmc bridge is an mmcbus. The mmcbus is described 74106649Spdeuskar * in dev/mmc/mmcbus_if.m. 75106649Spdeuskar */ 76119509Spdeuskar 77106649Spdeuskar/* 78106649Spdeuskar * mmc_ios is a structure that is used to store the state of the mmc/sd 79106649Spdeuskar * bus configuration. This include the bus' clock speed, its voltage, 80106649Spdeuskar * the bus mode for command output, the SPI chip select, some power 81106649Spdeuskar * states and the bus width. 82106649Spdeuskar */ 83106649Spdeuskarenum mmc_vdd { 84106649Spdeuskar vdd_150 = 0, vdd_155, vdd_160, vdd_165, vdd_170, vdd_180, 85108229Spdeuskar vdd_190, vdd_200, vdd_210, vdd_220, vdd_230, vdd_240, vdd_250, 86106649Spdeuskar vdd_260, vdd_270, vdd_280, vdd_290, vdd_300, vdd_310, vdd_320, 87106649Spdeuskar vdd_330, vdd_340, vdd_350, vdd_360 88163824Sglebius}; 89163824Sglebius 90108229Spdeuskarenum mmc_vccq { 91108229Spdeuskar vccq_120 = 0, vccq_180, vccq_330 92108229Spdeuskar}; 93119509Spdeuskar 94108229Spdeuskarenum mmc_power_mode { 95108229Spdeuskar power_off = 0, power_up, power_on 96119509Spdeuskar}; 97108229Spdeuskar 98108229Spdeuskarenum mmc_bus_mode { 99108229Spdeuskar opendrain = 1, pushpull 100108229Spdeuskar}; 101108229Spdeuskar 102119509Spdeuskarenum mmc_chip_select { 103106649Spdeuskar cs_dontcare = 0, cs_high, cs_low 104106649Spdeuskar}; 105106649Spdeuskar 106106649Spdeuskarenum mmc_bus_width { 107106649Spdeuskar bus_width_1 = 0, bus_width_4 = 2, bus_width_8 = 3 108106649Spdeuskar}; 109106649Spdeuskar 110106649Spdeuskarenum mmc_drv_type { 111106649Spdeuskar drv_type_b = 0, drv_type_a, drv_type_c, drv_type_d 112106649Spdeuskar}; 113119509Spdeuskar 114108229Spdeuskarenum mmc_bus_timing { 115163824Sglebius bus_timing_normal = 0, bus_timing_hs, bus_timing_uhs_sdr12, 116163824Sglebius bus_timing_uhs_sdr25, bus_timing_uhs_sdr50, bus_timing_uhs_ddr50, 117163824Sglebius bus_timing_uhs_sdr104, bus_timing_mmc_ddr52, bus_timing_mmc_hs200, 118163824Sglebius bus_timing_mmc_hs400, bus_timing_mmc_hs400es, bus_timing_max = 119106649Spdeuskar bus_timing_mmc_hs400es 120108229Spdeuskar}; 121106649Spdeuskar 122108229Spdeuskarstruct mmc_ios { 123119509Spdeuskar uint32_t clock; /* Speed of the clock in Hz to move data */ 124108229Spdeuskar enum mmc_vdd vdd; /* Voltage to apply to the power pins */ 125108229Spdeuskar enum mmc_vccq vccq; /* Voltage to use for signaling */ 126108229Spdeuskar enum mmc_bus_mode bus_mode; 127119509Spdeuskar enum mmc_chip_select chip_select; 128108229Spdeuskar enum mmc_bus_width bus_width; 129108229Spdeuskar enum mmc_power_mode power_mode; 130119509Spdeuskar enum mmc_bus_timing timing; 131108229Spdeuskar enum mmc_drv_type drv_type; 132108229Spdeuskar}; 133108229Spdeuskar 134106649Spdeuskarenum mmc_card_mode { 135106649Spdeuskar mode_mmc, mode_sd 136106649Spdeuskar}; 137106649Spdeuskar 138173788Sjfvenum mmc_retune_req { 13987189Spdeuskar retune_req_none = 0, retune_req_normal, retune_req_reset 140106649Spdeuskar}; 141106649Spdeuskar 142106649Spdeuskarstruct mmc_host { 143106649Spdeuskar int f_min; 144169240Sjfv int f_max; 145169589Sjfv uint32_t host_ocr; 14687189Spdeuskar uint32_t ocr; 147106649Spdeuskar uint32_t caps; 148106649Spdeuskar#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can do 4-bit data transfers */ 149106649Spdeuskar#define MMC_CAP_8_BIT_DATA (1 << 1) /* Can do 8-bit data transfers */ 150106649Spdeuskar#define MMC_CAP_HSPEED (1 << 2) /* Can do High Speed transfers */ 151106649Spdeuskar#define MMC_CAP_BOOT_NOACC (1 << 4) /* Cannot access boot partitions */ 152106649Spdeuskar#define MMC_CAP_WAIT_WHILE_BUSY (1 << 5) /* Host waits for busy responses */ 153106649Spdeuskar#define MMC_CAP_UHS_SDR12 (1 << 6) /* Can do UHS SDR12 */ 154106649Spdeuskar#define MMC_CAP_UHS_SDR25 (1 << 7) /* Can do UHS SDR25 */ 155106649Spdeuskar#define MMC_CAP_UHS_SDR50 (1 << 8) /* Can do UHS SDR50 */ 156106649Spdeuskar#define MMC_CAP_UHS_SDR104 (1 << 9) /* Can do UHS SDR104 */ 157106649Spdeuskar#define MMC_CAP_UHS_DDR50 (1 << 10) /* Can do UHS DDR50 */ 158106649Spdeuskar#define MMC_CAP_MMC_DDR52_120 (1 << 11) /* Can do eMMC DDR52 at 1.2 V */ 159106649Spdeuskar#define MMC_CAP_MMC_DDR52_180 (1 << 12) /* Can do eMMC DDR52 at 1.8 V */ 160115878Spdeuskar#define MMC_CAP_MMC_DDR52 (MMC_CAP_MMC_DDR52_120 | MMC_CAP_MMC_DDR52_180) 161106649Spdeuskar#define MMC_CAP_MMC_HS200_120 (1 << 13) /* Can do eMMC HS200 at 1.2 V */ 162169240Sjfv#define MMC_CAP_MMC_HS200_180 (1 << 14) /* Can do eMMC HS200 at 1.8 V */ 163106649Spdeuskar#define MMC_CAP_MMC_HS200 (MMC_CAP_MMC_HS200_120| MMC_CAP_MMC_HS200_180) 164169240Sjfv#define MMC_CAP_MMC_HS400_120 (1 << 15) /* Can do eMMC HS400 at 1.2 V */ 165169240Sjfv#define MMC_CAP_MMC_HS400_180 (1 << 16) /* Can do eMMC HS400 at 1.8 V */ 166169240Sjfv#define MMC_CAP_MMC_HS400 (MMC_CAP_MMC_HS400_120 | MMC_CAP_MMC_HS400_180) 167164546Skmacy#define MMC_CAP_MMC_HSX00_120 (MMC_CAP_MMC_HS200_120 | MMC_CAP_MMC_HS400_120) 168169240Sjfv#define MMC_CAP_MMC_ENH_STROBE (1 << 17) /* Can do eMMC Enhanced Strobe */ 169169240Sjfv#define MMC_CAP_SIGNALING_120 (1 << 18) /* Can do signaling at 1.2 V */ 170169240Sjfv#define MMC_CAP_SIGNALING_180 (1 << 19) /* Can do signaling at 1.8 V */ 171169240Sjfv#define MMC_CAP_SIGNALING_330 (1 << 20) /* Can do signaling at 3.3 V */ 172169240Sjfv#define MMC_CAP_DRIVER_TYPE_A (1 << 21) /* Can do Driver Type A */ 173164546Skmacy#define MMC_CAP_DRIVER_TYPE_C (1 << 22) /* Can do Driver Type C */ 174169240Sjfv#define MMC_CAP_DRIVER_TYPE_D (1 << 23) /* Can do Driver Type D */ 175164546Skmacy enum mmc_card_mode mode; 17687189Spdeuskar struct mmc_ios ios; /* Current state of the host */ 177169240Sjfv}; 178112472Spdeuskar 17987189Spdeuskarextern driver_t mmc_driver; 18087189Spdeuskarextern devclass_t mmc_devclass; 181112472Spdeuskar 182112472Spdeuskar#define MMC_VERSION 5 183169240Sjfv 18487189Spdeuskar#define MMC_DECLARE_BRIDGE(name) \ 18587189Spdeuskar DRIVER_MODULE(mmc, name, mmc_driver, mmc_devclass, NULL, NULL); \ 18687189Spdeuskar MODULE_DEPEND(name, mmc, MMC_VERSION, MMC_VERSION, MMC_VERSION); 18787189Spdeuskar#define MMC_DEPEND(name) \ 188169240Sjfv MODULE_DEPEND(name, mmc, MMC_VERSION, MMC_VERSION, MMC_VERSION); 189169240Sjfv 190108229Spdeuskar#endif /* DEV_MMC_BRIDGE_H */ 191173788Sjfv