Update version for v6.2.0-rc3 release
[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 #include "qom/object.h"
35
36 #define OUT_OF_RANGE (1 << 31)
37 #define ADDRESS_ERROR (1 << 30)
38 #define BLOCK_LEN_ERROR (1 << 29)
39 #define ERASE_SEQ_ERROR (1 << 28)
40 #define ERASE_PARAM (1 << 27)
41 #define WP_VIOLATION (1 << 26)
42 #define CARD_IS_LOCKED (1 << 25)
43 #define LOCK_UNLOCK_FAILED (1 << 24)
44 #define COM_CRC_ERROR (1 << 23)
45 #define ILLEGAL_COMMAND (1 << 22)
46 #define CARD_ECC_FAILED (1 << 21)
47 #define CC_ERROR (1 << 20)
48 #define SD_ERROR (1 << 19)
49 #define CID_CSD_OVERWRITE (1 << 16)
50 #define WP_ERASE_SKIP (1 << 15)
51 #define CARD_ECC_DISABLED (1 << 14)
52 #define ERASE_RESET (1 << 13)
53 #define CURRENT_STATE (7 << 9)
54 #define READY_FOR_DATA (1 << 8)
55 #define APP_CMD (1 << 5)
56 #define AKE_SEQ_ERROR (1 << 3)
57
58 enum SDPhySpecificationVersion {
59 SD_PHY_SPECv1_10_VERS = 1,
60 SD_PHY_SPECv2_00_VERS = 2,
61 SD_PHY_SPECv3_01_VERS = 3,
62 };
63
64 typedef enum {
65 SD_VOLTAGE_0_4V = 400, /* currently not supported */
66 SD_VOLTAGE_1_8V = 1800,
67 SD_VOLTAGE_3_0V = 3000,
68 SD_VOLTAGE_3_3V = 3300,
69 } sd_voltage_mv_t;
70
71 typedef enum {
72 UHS_NOT_SUPPORTED = 0,
73 UHS_I = 1,
74 UHS_II = 2, /* currently not supported */
75 UHS_III = 3, /* currently not supported */
76 } sd_uhs_mode_t;
77
78 typedef enum {
79 sd_none = -1,
80 sd_bc = 0, /* broadcast -- no response */
81 sd_bcr, /* broadcast with response */
82 sd_ac, /* addressed -- no data transfer */
83 sd_adtc, /* addressed with data transfer */
84 } sd_cmd_type_t;
85
86 typedef struct {
87 uint8_t cmd;
88 uint32_t arg;
89 uint8_t crc;
90 } SDRequest;
91
92
93 #define TYPE_SD_CARD "sd-card"
94 OBJECT_DECLARE_TYPE(SDState, SDCardClass, SD_CARD)
95
96 struct SDCardClass {
97 /*< private >*/
98 DeviceClass parent_class;
99 /*< public >*/
100
101 int (*do_command)(SDState *sd, SDRequest *req, uint8_t *response);
102 /**
103 * Write a byte to a SD card.
104 * @sd: card
105 * @value: byte to write
106 *
107 * Write a byte on the data lines of a SD card.
108 */
109 void (*write_byte)(SDState *sd, uint8_t value);
110 /**
111 * Read a byte from a SD card.
112 * @sd: card
113 *
114 * Read a byte from the data lines of a SD card.
115 *
116 * Return: byte value read
117 */
118 uint8_t (*read_byte)(SDState *sd);
119 bool (*receive_ready)(SDState *sd);
120 bool (*data_ready)(SDState *sd);
121 void (*set_voltage)(SDState *sd, uint16_t millivolts);
122 uint8_t (*get_dat_lines)(SDState *sd);
123 bool (*get_cmd_line)(SDState *sd);
124 void (*enable)(SDState *sd, bool enable);
125 bool (*get_inserted)(SDState *sd);
126 bool (*get_readonly)(SDState *sd);
127 };
128
129 #define TYPE_SD_BUS "sd-bus"
130 OBJECT_DECLARE_TYPE(SDBus, SDBusClass,
131 SD_BUS)
132
133 struct SDBus {
134 BusState qbus;
135 };
136
137 struct SDBusClass {
138 /*< private >*/
139 BusClass parent_class;
140 /*< public >*/
141
142 /* These methods are called by the SD device to notify the controller
143 * when the card insertion or readonly status changes
144 */
145 void (*set_inserted)(DeviceState *dev, bool inserted);
146 void (*set_readonly)(DeviceState *dev, bool readonly);
147 };
148
149 /* Functions to be used by qdevified callers (working via
150 * an SDBus rather than directly with SDState)
151 */
152 void sdbus_set_voltage(SDBus *sdbus, uint16_t millivolts);
153 uint8_t sdbus_get_dat_lines(SDBus *sdbus);
154 bool sdbus_get_cmd_line(SDBus *sdbus);
155 int sdbus_do_command(SDBus *sd, SDRequest *req, uint8_t *response);
156 /**
157 * Write a byte to a SD bus.
158 * @sd: bus
159 * @value: byte to write
160 *
161 * Write a byte on the data lines of a SD bus.
162 */
163 void sdbus_write_byte(SDBus *sd, uint8_t value);
164 /**
165 * Read a byte from a SD bus.
166 * @sd: bus
167 *
168 * Read a byte from the data lines of a SD bus.
169 *
170 * Return: byte value read
171 */
172 uint8_t sdbus_read_byte(SDBus *sd);
173 /**
174 * Write data to a SD bus.
175 * @sdbus: bus
176 * @buf: data to write
177 * @length: number of bytes to write
178 *
179 * Write multiple bytes of data on the data lines of a SD bus.
180 */
181 void sdbus_write_data(SDBus *sdbus, const void *buf, size_t length);
182 /**
183 * Read data from a SD bus.
184 * @sdbus: bus
185 * @buf: buffer to read data into
186 * @length: number of bytes to read
187 *
188 * Read multiple bytes of data on the data lines of a SD bus.
189 */
190 void sdbus_read_data(SDBus *sdbus, void *buf, size_t length);
191 bool sdbus_receive_ready(SDBus *sd);
192 bool sdbus_data_ready(SDBus *sd);
193 bool sdbus_get_inserted(SDBus *sd);
194 bool sdbus_get_readonly(SDBus *sd);
195 /**
196 * sdbus_reparent_card: Reparent an SD card from one controller to another
197 * @from: controller bus to remove card from
198 * @to: controller bus to move card to
199 *
200 * Reparent an SD card, effectively unplugging it from one controller
201 * and inserting it into another. This is useful for SoCs like the
202 * bcm2835 which have two SD controllers and connect a single SD card
203 * to them, selected by the guest reprogramming GPIO line routing.
204 */
205 void sdbus_reparent_card(SDBus *from, SDBus *to);
206
207 /* Functions to be used by SD devices to report back to qdevified controllers */
208 void sdbus_set_inserted(SDBus *sd, bool inserted);
209 void sdbus_set_readonly(SDBus *sd, bool inserted);
210
211 #endif /* HW_SD_H */