bridge.h revision 318198
1/*- 2 * Copyright (c) 2006 M. Warner Losh. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23 * 24 * Portions of this software may have been developed with reference to 25 * the SD Simplified Specification. The following disclaimer may apply: 26 * 27 * The following conditions apply to the release of the simplified 28 * specification ("Simplified Specification") by the SD Card Association and 29 * the SD Group. The Simplified Specification is a subset of the complete SD 30 * Specification which is owned by the SD Card Association and the SD 31 * Group. This Simplified Specification is provided on a non-confidential 32 * basis subject to the disclaimers below. Any implementation of the 33 * Simplified Specification may require a license from the SD Card 34 * Association, SD Group, SD-3C LLC or other third parties. 35 * 36 * Disclaimers: 37 * 38 * The information contained in the Simplified Specification is presented only 39 * as a standard specification for SD Cards and SD Host/Ancillary products and 40 * is provided "AS-IS" without any representations or warranties of any 41 * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD 42 * Card Association for any damages, any infringements of patents or other 43 * right of the SD Group, SD-3C LLC, the SD Card Association or any third 44 * parties, which may result from its use. No license is granted by 45 * implication, estoppel or otherwise under any patent or other rights of the 46 * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing 47 * herein shall be construed as an obligation by the SD Group, the SD-3C LLC 48 * or the SD Card Association to disclose or distribute any technical 49 * information, know-how or other confidential information to any third party. 50 * 51 * $FreeBSD: stable/10/sys/dev/mmc/bridge.h 318198 2017-05-11 21:01:02Z marius $ 52 */ 53 54#ifndef DEV_MMC_BRIDGE_H 55#define DEV_MMC_BRIDGE_H 56 57#include <sys/bus.h> 58 59/* 60 * This file defines interfaces for the mmc bridge. The names chosen 61 * are similar to or the same as the names used in Linux to allow for 62 * easy porting of what Linux calls mmc host drivers. I use the 63 * FreeBSD terminology of bridge and bus for consistency with other 64 * drivers in the system. This file corresponds roughly to the Linux 65 * linux/mmc/host.h file. 66 * 67 * A mmc bridge is a chipset that can have one or more mmc and/or sd 68 * cards attached to it. mmc cards are attached on a bus topology, 69 * while sd and sdio cards are attached using a star topology (meaning 70 * in practice each sd card has its own, independent slot). Each 71 * mmcbr is assumed to be derived from the mmcbr. This is done to 72 * allow for easier addition of bridges (as each bridge does not need 73 * to be added to the mmcbus file). 74 * 75 * Attached to the mmc bridge is an mmcbus. The mmcbus is described 76 * in dev/mmc/mmcbus_if.m. 77 */ 78 79/* 80 * mmc_ios is a structure that is used to store the state of the mmc/sd 81 * bus configuration. This include the bus' clock speed, its voltage, 82 * the bus mode for command output, the SPI chip select, some power 83 * states and the bus width. 84 */ 85enum mmc_vdd { 86 vdd_150 = 0, vdd_155, vdd_160, vdd_165, vdd_170, vdd_180, 87 vdd_190, vdd_200, vdd_210, vdd_220, vdd_230, vdd_240, vdd_250, 88 vdd_260, vdd_270, vdd_280, vdd_290, vdd_300, vdd_310, vdd_320, 89 vdd_330, vdd_340, vdd_350, vdd_360 90}; 91 92enum mmc_power_mode { 93 power_off = 0, power_up, power_on 94}; 95 96enum mmc_bus_mode { 97 opendrain = 1, pushpull 98}; 99 100enum mmc_chip_select { 101 cs_dontcare = 0, cs_high, cs_low 102}; 103 104enum mmc_bus_width { 105 bus_width_1 = 0, bus_width_4 = 2, bus_width_8 = 3 106}; 107 108enum mmc_bus_timing { 109 bus_timing_normal = 0, bus_timing_hs 110}; 111 112struct mmc_ios { 113 uint32_t clock; /* Speed of the clock in Hz to move data */ 114 enum mmc_vdd vdd; /* Voltage to apply to the power pins */ 115 enum mmc_bus_mode bus_mode; 116 enum mmc_chip_select chip_select; 117 enum mmc_bus_width bus_width; 118 enum mmc_power_mode power_mode; 119 enum mmc_bus_timing timing; 120}; 121 122enum mmc_card_mode { 123 mode_mmc, mode_sd 124}; 125 126struct mmc_host { 127 int f_min; 128 int f_max; 129 uint32_t host_ocr; 130 uint32_t ocr; 131 uint32_t caps; 132#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can do 4-bit data transfers */ 133#define MMC_CAP_8_BIT_DATA (1 << 1) /* Can do 8-bit data transfers */ 134#define MMC_CAP_HSPEED (1 << 2) /* Can do High Speed transfers */ 135#define MMC_CAP_BOOT_NOACC (1 << 4) /* Cannot access boot partitions */ 136#define MMC_CAP_WAIT_WHILE_BUSY (1 << 5) /* Host waits for busy responses */ 137 enum mmc_card_mode mode; 138 struct mmc_ios ios; /* Current state of the host */ 139}; 140 141extern driver_t mmc_driver; 142extern devclass_t mmc_devclass; 143 144#define MMC_VERSION 2 145 146#define MMC_DECLARE_BRIDGE(name) \ 147 DRIVER_MODULE(mmc, name, mmc_driver, mmc_devclass, NULL, NULL); \ 148 MODULE_DEPEND(name, mmc, MMC_VERSION, MMC_VERSION, MMC_VERSION); 149#define MMC_DEPEND(name) \ 150 MODULE_DEPEND(name, mmc, MMC_VERSION, MMC_VERSION, MMC_VERSION); 151 152#endif /* DEV_MMC_BRIDGE_H */ 153