1# MMC 2 3## 概述 4 5### 功能简介 6 7MMC（MultiMedia Card）即多媒体卡，是一种用于固态非易失性存储的小体积大容量的快闪存储卡。 8 9MMC后续泛指一个接口协定（一种卡式），能符合这种接口的内存器都可称作MMC储存体。主要包括几个部分：MMC控制器、MMC总线、存储卡（包括MMC卡、SD卡、SDIO卡、TF卡）。 10 11MMC、SD、SDIO总线，其总线规范类似，都是从MMC总线规范演化而来的。MMC强调的是多媒体存储；SD强调的是安全和数据保护；SDIO是从SD演化出来的，强调的是接口，不再关注另一端的具体形态（可以是WIFI设备、Bluetooth设备、GPS等等）。 12 13### 基本概念 14 15- SD卡（Secure Digital Memory Card） 16 17 SD卡即安全数码卡。它是在MMC的基础上发展而来，SD卡强调数据的安全安全，可以设定存储内容的使用权限，防止数据被他人复制。在数据传输和物理规范上，SD卡（24mm\*32mm\*2.1mm，比MMC卡更厚一点），向前兼容了MMC卡。所有支持SD卡的设备也支持MMC卡。 18 19- SDIO（Secure Digital Input and Output） 20 21 即安全数字输入输出接口。SDIO是在SD规范的标准上定义的一种外设接口，它相较于SD规范增加了低速标准，可以用最小的硬件开销支持低速I/O。SDIO接口兼容以前的SD内存卡，也可以连接SDIO接口的设备。 22 23### 运作机制 24 25在HDF框架中，MMC的接口适配模式采用独立服务模式（如图1所示）。在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力，但需要为每个设备单独配置设备节点，增加内存占用。 26 27独立服务模式下，核心层不会统一发布一个服务供上层使用，因此这种模式下驱动要为每个控制器发布一个服务，具体表现为： 28 29- 驱动适配者需要实现HdfDriverEntry的Bind钩子函数以绑定服务。 30- device_info.hcs文件中deviceNode的policy字段为1或2，不能为0。 31 32MMC模块各分层作用： 33 34- 接口层提供打开MMC设备、检查MMC控制器是否存在设备、关闭MMC设备的接口。 35- 核心层主要提供MMC控制器、移除和管理的能力，还有公共控制器业务。通过钩子函数与适配层交互。 36- 适配层主要是将钩子函数的功能实例化，实现具体的功能。 37 38**图1** MMC独立服务模式结构图 39 40 41 42## 开发指导 43 44### 场景介绍 45 46MMC用于多媒体文件的存储，当驱动开发者需要将MMC设备适配到OpenHarmony时，需要进行MMC驱动适配。下文将介绍如何进行MMC驱动适配。 47 48### 接口说明 49 50为了保证上层在调用MMC接口时能够正确的操作MMC控制器，核心层在//drivers/hdf_core/framework/model/storage/include/mmc/mmc_corex.h中定义了以下钩子函数，驱动适配者需要在适配层实现这些函数的具体功能，并与钩子函数挂接，从而完成适配层与核心层的交互。 51 52MmcCntlrOps定义： 53 54```c 55struct MmcCntlrOps { 56 int32_t (*request)(struct MmcCntlr *cntlr, struct MmcCmd *cmd); 57 int32_t (*setClock)(struct MmcCntlr *cntlr, uint32_t clock); 58 int32_t (*setPowerMode)(struct MmcCntlr *cntlr, enum MmcPowerMode mode); 59 int32_t (*setBusWidth)(struct MmcCntlr *cntlr, enum MmcBusWidth width); 60 int32_t (*setBusTiming)(struct MmcCntlr *cntlr, enum MmcBusTiming timing); 61 int32_t (*setSdioIrq)(struct MmcCntlr *cntlr, bool enable); 62 int32_t (*hardwareReset)(struct MmcCntlr *cntlr); 63 int32_t (*systemInit)(struct MmcCntlr *cntlr); 64 int32_t (*setEnhanceStrobe)(struct MmcCntlr *cntlr, bool enable); 65 int32_t (*switchVoltage)(struct MmcCntlr *cntlr, enum MmcVolt volt); 66 bool (*devReadOnly)(struct MmcCntlr *cntlr); 67 bool (*devPlugged)(struct MmcCntlr *cntlr); 68 bool (*devBusy)(struct MmcCntlr *cntlr); 69 int32_t (*tune)(struct MmcCntlr *cntlr, uint32_t cmdCode); 70 int32_t (*rescanSdioDev)(struct MmcCntlr *cntlr); 71}; 72``` 73 74**表1** MmcCntlrOps结构体成员的钩子函数功能说明 75 76| 成员函数 | 入参 | 返回值 | 功能 | 77| -------- | -------- | -------- | -------- | 78| doRequest | cntlr：结构体指针，核心层MMC控制器<br>cmd：结构体指针,传入命令值 | HDF_STATUS相关状态 | request相应处理 | 79| setClock | cntlr：结构体指针，核心层MMC控制器<br>clock：时钟传入值 | HDF_STATUS相关状态 | 设置时钟频率 | 80| setPowerMode | cntlr：结构体指针，核心层MMC控制器<br>mode：枚举值（见MmcPowerMode定义），功耗模式 | HDF_STATUS相关状态 | 设置功耗模式 | 81| setBusWidth | cntlr：核心层结构体指针，核心层MMMC控制器<br>width：枚举值（见MmcBusWidth定义），总线带宽 | HDF_STATUS相关状态 | 设置总线带宽 | 82| setBusTiming | cntlr：结构体指针，核心层MMC控制器<br>timing：枚举值（见MmcBusTiming定义），总线时序 | HDF_STATUS相关状态 | 设置总线时序 | 83| setSdioIrq | cntlr：结构体指针，核心层MMC控制器<br>enable：布尔值，控制中断 | HDF_STATUS相关状态 | 使能/去使能SDIO中断 | 84| hardwareReset | cntlr：结构体指针，核心层MMC控制器 | HDF_STATUS相关状态 | 复位硬件 | 85| systemInit | cntlr：结构体指针，核心层MMC控制器 | HDF_STATUS相关状态 | 系统初始化 | 86| setEnhanceStrobe | cntlr：结构体指针，核心层MMC控制器<br>enable：布尔值，设置功能 | HDF_STATUS相关状态 | 设置增强选通 | 87| switchVoltage | cntlr：结构体指针，核心层MMC控制器<br>volt：枚举值，电压值（3.3,1.8,1.2V） | HDF_STATUS相关状态 | 设置电压值 | 88| devReadOnly | cntlr：结构体指针，核心层MMC控制器 | 布尔值 | 检验设备是否只读 | 89| cardPlugged | cntlr：结构体指针，核心层MMC控制器 | 布尔值 | 检验设备是否拔出 | 90| devBusy | cntlr：结构体指针，核心层MMC控制器 | 布尔值 | 检验设备是否忙碌 | 91| tune | cntlr：结构体指针，核心层MMC控制器<br>cmdCode：uint32_t类型，命令代码 | HDF_STATUS相关状态 | 调谐 | 92| rescanSdioDev | cntlr：结构体指针，核心层MMC控制器 | HDF_STATUS相关状态 | 扫描并添加SDIO设备 | 93 94### 开发步骤 95 96MMC模块适配包含以下四个步骤： 97 98- 实例化驱动入口。 99- 配置属性文件。 100- 实例化MMC控制器对象。 101- 驱动调试。 102 103### 开发实例 104 105下方将基于Hi3516DV300开发板以//device_soc_hisilicon/common/platform/mmc/himci_v200/himci.c驱动为示例，展示需要驱动适配者提供哪些内容来完整实现设备功能。 106 1071. 实例化驱动入口。 108 109 驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 110 一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 111 112 MMC驱动入口开发参考： 113 114 ```c 115 struct HdfDriverEntry g_mmcDriverEntry = { 116 .moduleVersion = 1, 117 .Bind = HimciMmcBind, // 见Bind参考 118 .Init = HimciMmcInit, // 见Init参考 119 .Release = HimciMmcRelease, // 见Release参考 120 .moduleName = "hi3516_mmc_driver", // 【必要且与HCS文件中里面的moduleName匹配】 121 }; 122 HDF_INIT(g_mmcDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中 123 ``` 124 1252. 配置属性文件。 126 127 完成驱动入口注册之后，需要在device_info.hcs文件中添加deviceNode信息，deviceNode信息与驱动入口注册相关。本例以三个MMC控制器为例，如有多个器件信息，则需要在device_info.hcs文件增加对应的deviceNode信息。器件属性值与核心层MmcCntlr成员的默认值或限制范围有密切关系，需要在mmc_config.hcs中配置器件属性。 128 129 - device_info.hcs 配置参考： 130 131 在//vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode描述。 132 133 ```c 134 root { 135 device_info { 136 match_attr = "hdf_manager"; 137 platform :: host { 138 hostName = "platform_host"; 139 priority = 50; 140 device_mmc:: device { 141 device0 :: deviceNode { // 驱动的DeviceNode节点 142 policy = 2; // policy字段是驱动服务发布的策略,如果需要面向用户态，则为2 143 priority = 10; // 驱动启动优先级 144 permission = 0644; // 驱动创建设备节点权限 145 moduleName = "hi3516_mmc_driver"; // 【必要】用于指定驱动名称，需要与驱动Entry中的moduleName一致。 146 serviceName = "HDF_PLATFORM_MMC_0"; // 【必要】驱动对外发布服务的名称，必须唯一。 147 deviceMatchAttr = "hi3516_mmc_emmc"; // 【必要】用于配置控制器私有数据，要与mmc_config.hcs中对应控制器保持一致。 148 } 149 device1 :: deviceNode { 150 policy = 1; 151 priority = 20; 152 permission = 0644; 153 moduleName = "hi3516_mmc_driver"; 154 serviceName = "HDF_PLATFORM_MMC_1"; 155 deviceMatchAttr = "hi3516_mmc_sd"; // SD类型 156 } 157 device2 :: deviceNode { 158 policy = 1; 159 priority = 30; 160 permission = 0644; 161 moduleName = "hi3516_mmc_driver"; 162 serviceName = "HDF_PLATFORM_MMC_2"; 163 deviceMatchAttr = "hi3516_mmc_sdio"; // SDIO类型 164 } 165 ... 166 } 167 } 168 } 169 } 170 ``` 171 172 - mmc_config.hcs配置参考： 173 174 在//device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/mmc/mmc_config.hcs文件配置器件属性，其中配置参数如下： 175 176 ```c 177 root { 178 platform { 179 mmc_config { 180 template mmc_controller { // 配置模板，如果下面节点使用时继承该模板，则节点中未声明的字段会使用该模板中的默认值。 181 match_attr = ""; 182 voltDef = 0; // MMC默认电压，0代表3.3V，1代表1.8V，2代表1.2V 183 freqMin = 50000; // 【必要】最小频率值 184 freqMax = 100000000; // 【必要】最大频率值 185 freqDef = 400000; // 【必要】默认频率值 186 maxBlkNum = 2048; // 【必要】最大的block号 187 maxBlkSize = 512; // 【必要】最大的block个数 188 ocrDef = 0x300000; // 【必要】工作电压设置相关 189 caps2 = 0; // 【必要】属性寄存器相关，见mmc_caps.h中MmcCaps2定义。 190 regSize = 0x118; // 【必要】寄存器位宽 191 hostId = 0; // 【必要】主机号 192 regBasePhy = 0x10020000; // 【必要】寄存器物理基地址 193 irqNum = 63; // 【必要】中断号 194 devType = 2; // 【必要】模式选择：EMMC、SD、SDIO、COMBO 195 caps = 0x0001e045; // 【必要】属性寄存器相关，见mmc_caps.h中MmcCaps定义。 196 } 197 controller_0x10100000 :: mmc_controller { 198 match_attr = "hi3516_mmc_emmc"; // 【必要】需要和device_info.hcs中的deviceMatchAttr值一致 199 hostId = 0; 200 regBasePhy = 0x10100000; 201 irqNum = 96; 202 devType = 0; // eMMC类型 203 caps = 0xd001e045; 204 caps2 = 0x60; 205 } 206 controller_0x100f0000 :: mmc_controller { 207 match_attr = "hi3516_mmc_sd"; 208 hostId = 1; 209 regBasePhy = 0x100f0000; 210 irqNum = 62; 211 devType = 1; // SD类型 212 caps = 0xd001e005; 213 } 214 controller_0x10020000 :: mmc_controller { 215 match_attr = "hi3516_mmc_sdio"; 216 hostId = 2; 217 regBasePhy = 0x10020000; 218 irqNum = 63; 219 devType = 2; // SDIO类型 220 caps = 0x0001e04d; 221 } 222 } 223 } 224 } 225 ``` 226 227 需要注意的是，新增mmc_config.hcs配置文件后，必须在产品对应的hdf.hcs文件中将其包含如下语句所示，否则配置文件无法生效。 228 229 ```c 230 #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/mmc/mmc_config.hcs" // 配置文件相对路径 231 ``` 232 2333. 实例化MMC控制器对象。 234 235 完成配置属性文件之后，下一步就是以核心层MmcCntlr对象的初始化为核心，包括驱动适配自定义结构体（传递参数和数据），实例化MmcCntlr成员MmcCntlrOps（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。 236 237 - 驱动适配者自定义结构体参考 238 239 从驱动的角度看，自定义结构体是参数和数据的载体，而且mmc_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象。 240 241 ```c 242 struct HimciHost { 243 struct MmcCntlr *mmc; // 【必要】核心层控制对象 244 struct MmcCmd *cmd; // 【必要】核心层结构体，传递命令，相关命令见枚举量MmcCmdCode 245 void *base; // 地址映射需要，寄存器基地址 246 enum HimciPowerStatus powerStatus; 247 uint8_t *alignedBuff; 248 uint32_t buffLen; 249 struct scatterlist dmaSg; 250 struct scatterlist *sg; 251 uint32_t dmaSgNum; 252 DMA_ADDR_T dmaPaddr; 253 uint32_t *dmaVaddr; 254 uint32_t irqNum; 255 bool isTuning; 256 uint32_t id; 257 struct OsalMutex mutex; 258 bool waitForEvent; 259 HIMCI_EVENT himciEvent; 260 }; 261 // MmcCntlr是核心层控制器结构体，其中的成员在Bind函数中会被赋值。 262 struct MmcCntlr { 263 struct IDeviceIoService service; 264 struct HdfDeviceObject *hdfDevObj; 265 struct PlatformDevice device; 266 struct OsalMutex mutex; 267 struct OsalSem released; 268 uint32_t devType; 269 struct MmcDevice *curDev; 270 struct MmcCntlrOps *ops; 271 struct PlatformQueue *msgQueue; 272 uint16_t index; 273 uint16_t voltDef; 274 uint32_t vddBit; 275 uint32_t freqMin; 276 uint32_t freqMax; 277 uint32_t freqDef; 278 union MmcOcr ocrDef; 279 union MmcCaps caps; 280 union MmcCaps2 caps2; 281 uint32_t maxBlkNum; 282 uint32_t maxBlkSize; 283 uint32_t maxReqSize; 284 bool devPlugged; 285 bool detecting; 286 void *priv; 287 }; 288 ``` 289 290 - MmcCntlr成员钩子函数结构体MmcCntlrOps的实例化，其他成员在Bind函数中初始化。 291 292 ```c 293 static struct MmcCntlrOps g_himciHostOps = { 294 .request = HimciDoRequest, 295 .setClock = HimciSetClock, 296 .setPowerMode = HimciSetPowerMode, 297 .setBusWidth = HimciSetBusWidth, 298 .setBusTiming = HimciSetBusTiming, 299 .setSdioIrq = HimciSetSdioIrq, 300 .hardwareReset = HimciHardwareReset, 301 .systemInit = HimciSystemInit, 302 .setEnhanceStrobe = HimciSetEnhanceStrobe, 303 .switchVoltage = HimciSwitchVoltage, 304 .devReadOnly = HimciDevReadOnly, 305 .devPlugged = HimciCardPlugged, 306 .devBusy = HimciDevBusy, 307 .tune = HimciTune, 308 .rescanSdioDev = HimciRescanSdioDev, 309 }; 310 ``` 311 312 - Bind函数开发参考 313 314 入参： 315 316 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 317 318 返回值： 319 320 HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 321 322 **表2** Bind函数说明 323 324 | 状态(值) | 问题描述 | 325 | -------- | -------- | 326 | HDF_ERR_INVALID_OBJECT | 控制器对象非法 | 327 | HDF_ERR_MALLOC_FAIL | 内存分配失败 | 328 | HDF_ERR_INVALID_PARAM | 参数非法 | 329 | HDF_ERR_IO | I/O 错误 | 330 | HDF_SUCCESS | 初始化成功 | 331 | HDF_FAILURE | 初始化失败 | 332 333 函数说明： 334 335 MmcCntlr、HimciHost、HdfDeviceObject之间互相赋值，方便其他函数可以相互转化，初始化自定义结构体HimciHost对象，初始化MmcCntlr成员，调用核心层MmcCntlrAdd函数，完成MMC控制器的添加。 336 337 ```c 338 static int32_t HimciMmcBind(struct HdfDeviceObject *obj) 339 { 340 struct MmcCntlr *cntlr = NULL; 341 struct HimciHost *host = NULL; 342 int32_t ret; 343 cntlr = (struct MmcCntlr *)OsalMemCalloc(sizeof(struct MmcCntlr)); 344 host = (struct HimciHost *)OsalMemCalloc(sizeof(struct HimciHost)); 345 346 host->mmc = cntlr; // 【必要】使HimciHost与MmcCntlr可以相互转化的前提 347 cntlr->priv = (void *)host; // 【必要】使HimciHost与MmcCntlr可以相互转化的前提 348 cntlr->ops = &g_himciHostOps; // 【必要】MmcCntlrOps的实例化对象的挂载 349 cntlr->hdfDevObj = obj; // 【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 350 obj->service = &cntlr->service; // 【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 351 ret = MmcCntlrParse(cntlr, obj); // 【必要】 初始化cntlr，失败就goto _ERR。 352 ... 353 ret = HimciHostParse(host, obj); // 【必要】 初始化host对象的相关属性，失败就goto _ERR。 354 ... 355 ret = HimciHostInit(host, cntlr); // 驱动适配者自定义的初始化，失败就goto _ERR。 356 ... 357 ret = MmcCntlrAdd(cntlr); // 调用核心层函数，失败就goto _ERR。 358 ... 359 (void)MmcCntlrAddDetectMsgToQueue(cntlr); // 将卡检测消息添加到队列中。 360 HDF_LOGD("HimciMmcBind: success."); 361 return HDF_SUCCESS; 362 ERR: 363 HimciDeleteHost(host); 364 HDF_LOGD("HimciMmcBind: fail, err = %d.", ret); 365 return ret; 366 } 367 ``` 368 369 - Init函数开发参考 370 371 入参： 372 373 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 374 375 返回值： 376 377 HDF_STATUS相关状态。 378 379 函数说明： 380 381 实现ProcMciInit。 382 383 ```c 384 static int32_t HimciMmcInit(struct HdfDeviceObject *obj) 385 { 386 static bool procInit = false; 387 (void)obj; 388 if (procInit == false) { 389 if (ProcMciInit() == HDF_SUCCESS) { 390 procInit = true; 391 HDF_LOGD("HimciMmcInit: proc init success."); 392 } 393 } 394 HDF_LOGD("HimciMmcInit: success."); 395 return HDF_SUCCESS; 396 } 397 ``` 398 399 - Release函数开发参考 400 401 入参： 402 403 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 404 405 返回值： 406 407 无。 408 409 函数说明： 410 411 释放内存和删除控制器等操作，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。 412 413 >  **说明：**<br> 414 > 所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。 415 416 ```c 417 static void HimciMmcRelease(struct HdfDeviceObject *obj) 418 { 419 struct MmcCntlr *cntlr = NULL; 420 ... 421 cntlr = (struct MmcCntlr *)obj->service; // 这里有HdfDeviceObject到MmcCntlr的强制转化，通过service成员，赋值见Bind函数。 422 ... 423 HimciDeleteHost((struct HimciHost *)cntlr->priv); // 驱动适配者自定义的内存释放函数，这里有MmcCntlr到HimciHost的强制转化。 424 } 425 ``` 426 4274. 驱动调试。 428 429 【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，数据传输的成功与否等。
