hw/intc/armv7m_nvic: Provide default "reset the system" behaviour for SYSRESETREQ
[qemu.git] / include / hw / sd / sd.h
1 /*
2 * SD Memory Card emulation. Mostly correct for MMC too.
3 *
4 * Copyright (c) 2006 Andrzej Zaborowski <balrog@zabor.org>
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
15 * distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
18 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
19 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
21 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
25 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30 #ifndef HW_SD_H
31 #define HW_SD_H
32
33 #include "hw/qdev-core.h"
34
35 #define OUT_OF_RANGE (1 << 31)
36 #define ADDRESS_ERROR (1 << 30)
37 #define BLOCK_LEN_ERROR (1 << 29)
38 #define ERASE_SEQ_ERROR (1 << 28)
39 #define ERASE_PARAM (1 << 27)
40 #define WP_VIOLATION (1 << 26)
41 #define CARD_IS_LOCKED (1 << 25)
42 #define LOCK_UNLOCK_FAILED (1 << 24)
43 #define COM_CRC_ERROR (1 << 23)
44 #define ILLEGAL_COMMAND (1 << 22)
45 #define CARD_ECC_FAILED (1 << 21)
46 #define CC_ERROR (1 << 20)
47 #define SD_ERROR (1 << 19)
48 #define CID_CSD_OVERWRITE (1 << 16)
49 #define WP_ERASE_SKIP (1 << 15)
50 #define CARD_ECC_DISABLED (1 << 14)
51 #define ERASE_RESET (1 << 13)
52 #define CURRENT_STATE (7 << 9)
53 #define READY_FOR_DATA (1 << 8)
54 #define APP_CMD (1 << 5)
55 #define AKE_SEQ_ERROR (1 << 3)
56
57 enum SDPhySpecificationVersion {
58 SD_PHY_SPECv1_10_VERS = 1,
59 SD_PHY_SPECv2_00_VERS = 2,
60 SD_PHY_SPECv3_01_VERS = 3,
61 };
62
63 typedef enum {
64 SD_VOLTAGE_0_4V = 400, /* currently not supported */
65 SD_VOLTAGE_1_8V = 1800,
66 SD_VOLTAGE_3_0V = 3000,
67 SD_VOLTAGE_3_3V = 3300,
68 } sd_voltage_mv_t;
69
70 typedef enum {
71 UHS_NOT_SUPPORTED = 0,
72 UHS_I = 1,
73 UHS_II = 2, /* currently not supported */
74 UHS_III = 3, /* currently not supported */
75 } sd_uhs_mode_t;
76
77 typedef enum {
78 sd_none = -1,
79 sd_bc = 0, /* broadcast -- no response */
80 sd_bcr, /* broadcast with response */
81 sd_ac, /* addressed -- no data transfer */
82 sd_adtc, /* addressed with data transfer */
83 } sd_cmd_type_t;
84
85 typedef struct {
86 uint8_t cmd;
87 uint32_t arg;
88 uint8_t crc;
89 } SDRequest;
90
91 typedef struct SDState SDState;
92 typedef struct SDBus SDBus;
93
94 #define TYPE_SD_CARD "sd-card"
95 #define SD_CARD(obj) OBJECT_CHECK(SDState, (obj), TYPE_SD_CARD)
96 #define SD_CARD_CLASS(klass) \
97 OBJECT_CLASS_CHECK(SDCardClass, (klass), TYPE_SD_CARD)
98 #define SD_CARD_GET_CLASS(obj) \
99 OBJECT_GET_CLASS(SDCardClass, (obj), TYPE_SD_CARD)
100
101 typedef struct {
102 /*< private >*/
103 DeviceClass parent_class;
104 /*< public >*/
105
106 int (*do_command)(SDState *sd, SDRequest *req, uint8_t *response);
107 void (*write_data)(SDState *sd, uint8_t value);
108 uint8_t (*read_data)(SDState *sd);
109 bool (*data_ready)(SDState *sd);
110 void (*set_voltage)(SDState *sd, uint16_t millivolts);
111 uint8_t (*get_dat_lines)(SDState *sd);
112 bool (*get_cmd_line)(SDState *sd);
113 void (*enable)(SDState *sd, bool enable);
114 bool (*get_inserted)(SDState *sd);
115 bool (*get_readonly)(SDState *sd);
116 } SDCardClass;
117
118 #define TYPE_SD_BUS "sd-bus"
119 #define SD_BUS(obj) OBJECT_CHECK(SDBus, (obj), TYPE_SD_BUS)
120 #define SD_BUS_CLASS(klass) OBJECT_CLASS_CHECK(SDBusClass, (klass), TYPE_SD_BUS)
121 #define SD_BUS_GET_CLASS(obj) OBJECT_GET_CLASS(SDBusClass, (obj), TYPE_SD_BUS)
122
123 struct SDBus {
124 BusState qbus;
125 };
126
127 typedef struct {
128 /*< private >*/
129 BusClass parent_class;
130 /*< public >*/
131
132 /* These methods are called by the SD device to notify the controller
133 * when the card insertion or readonly status changes
134 */
135 void (*set_inserted)(DeviceState *dev, bool inserted);
136 void (*set_readonly)(DeviceState *dev, bool readonly);
137 } SDBusClass;
138
139 /* Legacy functions to be used only by non-qdevified callers */
140 SDState *sd_init(BlockBackend *bs, bool is_spi);
141 int sd_do_command(SDState *sd, SDRequest *req,
142 uint8_t *response);
143 void sd_write_data(SDState *sd, uint8_t value);
144 uint8_t sd_read_data(SDState *sd);
145 void sd_set_cb(SDState *sd, qemu_irq readonly, qemu_irq insert);
146 bool sd_data_ready(SDState *sd);
147 /* sd_enable should not be used -- it is only used on the nseries boards,
148 * where it is part of a broken implementation of the MMC card slot switch
149 * (there should be two card slots which are multiplexed to a single MMC
150 * controller, but instead we model it with one card and controller and
151 * disable the card when the second slot is selected, so it looks like the
152 * second slot is always empty).
153 */
154 void sd_enable(SDState *sd, bool enable);
155
156 /* Functions to be used by qdevified callers (working via
157 * an SDBus rather than directly with SDState)
158 */
159 void sdbus_set_voltage(SDBus *sdbus, uint16_t millivolts);
160 uint8_t sdbus_get_dat_lines(SDBus *sdbus);
161 bool sdbus_get_cmd_line(SDBus *sdbus);
162 int sdbus_do_command(SDBus *sd, SDRequest *req, uint8_t *response);
163 void sdbus_write_data(SDBus *sd, uint8_t value);
164 uint8_t sdbus_read_data(SDBus *sd);
165 bool sdbus_data_ready(SDBus *sd);
166 bool sdbus_get_inserted(SDBus *sd);
167 bool sdbus_get_readonly(SDBus *sd);
168 /**
169 * sdbus_reparent_card: Reparent an SD card from one controller to another
170 * @from: controller bus to remove card from
171 * @to: controller bus to move card to
172 *
173 * Reparent an SD card, effectively unplugging it from one controller
174 * and inserting it into another. This is useful for SoCs like the
175 * bcm2835 which have two SD controllers and connect a single SD card
176 * to them, selected by the guest reprogramming GPIO line routing.
177 */
178 void sdbus_reparent_card(SDBus *from, SDBus *to);
179
180 /* Functions to be used by SD devices to report back to qdevified controllers */
181 void sdbus_set_inserted(SDBus *sd, bool inserted);
182 void sdbus_set_readonly(SDBus *sd, bool inserted);
183
184 #endif /* HW_SD_H */