1# SDIO 2 3## 概述 4 5### 功能简介 6 7SDIO（Secure Digital Input and Output）由SD卡发展而来，与SD卡统称为MMC（MultiMediaCard），二者使用相同的通信协议。SDIO接口兼容以前的SD卡，并且可以连接支持SDIO接口的其他设备。 8 9### 运作机制 10 11在HDF框架中，SDIO的接口适配模式采用独立服务模式（如图1）。在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力，但需要为每个设备单独配置设备节点，若设备过多可能增加内存占用。 12 13独立服务模式下，核心层不会统一发布一个服务供上层使用，因此这种模式下驱动要为每个控制器发布一个服务，具体表现为： 14 15- 驱动适配者需要实现HdfDriverEntry的Bind钩子函数以绑定服务。 16- device_info.hcs文件中deviceNode的policy字段为1或2，不能为0。 17 18**图1** SDIO独立服务模式结构图<a name="fig1"></a> 19 20 21 22### 约束与限制 23 24SDIO模块API当前仅支持内核态调用。 25 26## 开发指导 27 28### 场景介绍 29 30SDIO的应用比较广泛，目前，有许多手机都支持SDIO功能，并且很多SDIO外设也被开发出来，使得手机外接外设更加容易。常见的SDIO外设有WLAN、GPS、CAMERA、蓝牙等。当驱动开发者需要将SDIO设备适配到OpenHarmony时，需要进行SDIO驱动适配，下文将介绍如何进行SDIO驱动适配。 31 32### 接口说明 33 34为了保证上层在调用SDIO接口时能够正确的操作硬件，核心层在//drivers/hdf_core/framework/model/storage/include/mmc//mmc_sdio.h中定义了以下钩子函数。驱动适配者需要在适配层实现这些函数的具体功能，并与这些钩子函数挂接，从而完成接口层与核心层的交互。 35 36SdioDeviceOps定义： 37 38```c 39/* 函数模板 */ 40struct SdioDeviceOps { 41 int32_t (*incrAddrReadBytes)(struct SdioDevice *dev, uint8_t *data, uint32_t addr, uint32_t size); 42 int32_t (*incrAddrWriteBytes)(struct SdioDevice *dev, uint8_t *data, uint32_t addr, uint32_t size); 43 int32_t (*fixedAddrReadBytes)(struct SdioDevice *dev, uint8_t *data, uint32_t addr, uint32_t size, uint32_t scatterLen); 44 int32_t (*fixedAddrWriteBytes)(struct SdioDevice *dev, uint8_t *data, uint32_t addr, uint32_t size, uint32_t scatterLen); 45 int32_t (*func0ReadBytes)(struct SdioDevice *dev, uint8_t *data, uint32_t addr, uint32_t size); 46 int32_t (*func0WriteBytes)(struct SdioDevice *dev, uint8_t *data, uint32_t addr, uint32_t size); 47 int32_t (*setBlockSize)(struct SdioDevice *dev, uint32_t blockSize); 48 int32_t (*getCommonInfo)(struct SdioDevice *dev, SdioCommonInfo *info, uint32_t infoType); 49 int32_t (*setCommonInfo)(struct SdioDevice *dev, SdioCommonInfo *info, uint32_t infoType); 50 int32_t (*flushData)(struct SdioDevice *dev); 51 int32_t (*enableFunc)(struct SdioDevice *dev); 52 int32_t (*disableFunc)(struct SdioDevice *dev); 53 int32_t (*claimIrq)(struct SdioDevice *dev, SdioIrqHandler *irqHandler); 54 int32_t (*releaseIrq)(struct SdioDevice *dev); 55 int32_t (*findFunc)(struct SdioDevice *dev, struct SdioFunctionConfig *configData); 56 int32_t (*claimHost)(struct SdioDevice *dev); 57 int32_t (*releaseHost)(struct SdioDevice *dev); 58}; 59``` 60 61 **表1** SdioDeviceOps结构体成员的钩子函数功能说明 62 63| 函数 | 入参 | 出参 | 返回值 | 功能 | 64| -------- | -------- | -------- | -------- | -------- | 65| incrAddrReadBytes | dev：结构体指针，SDIO设备控制器<br>addr：uint32_t，地址值<br>size：uint32_t，大小 | data：uint8_t指针，传出值 | HDF_STATUS相关状态 | 从指定的SDIO地址增量读取给定长度的数据 | 66| incrAddrWriteBytes | dev：结构体指针，SDIO设备控制器<br>data：uint8_t指针，传入值<br>addr：uint32_t，地址值<br>size：uint32_t，大小 | 无 | HDF_STATUS相关状态 | 将给定长度的数据增量写入指定的SDIO地址 | 67| fixedAddrReadBytes | dev：结构体指针，SDIO设备控制器<br>addr：uint32_t，地址值<br>size：uint32_t，大小<br>scatterLen：uint32_t，数据长度 | data：uint8_t指针，传出值 | HDF_STATUS相关状态 | 从固定SDIO地址读取给定长度的数据。 | 68| fixedAddrWriteBytes | dev：结构体指针，SDIO设备控制器<br>data：uint8_t指针，传入值<br>addr：uint32_t，地址值<br>size：uint32_t，大小<br>scatterLen：uint32_t，数据长度 | 无 | HDF_STATUS相关状态 | 将给定长度的数据写入固定SDIO地址 | 69| func0ReadBytes | dev：结构体指针，SDIO设备控制器<br>addr：uint32_t，地址值<br>size：uint32_t，大小 | data：uint8_t指针，传出值 | HDF_STATUS相关状态 | 从SDIO函数0的地址空间读取给定长度的数据。 | 70| func0WriteBytes | dev：结构体指针，SDIO设备控制器<br>data：uint8_t指针，传入值<br>addr：uint32_t，地址值<br>size：uint32_t，大小 | 无 | HDF_STATUS相关状态 | 将给定长度的数据写入SDIO函数0的地址空间。 | 71| setBlockSize | dev：结构体指针，SDIO设备控制器<br>blockSize：uint32_t，Block大小 | 无 | HDF_STATUS相关状态 | 设置block大小 | 72| getCommonInfo | dev：联合体指针，SDIO设备控制器<br>infoType：uint32_t，info类型 | info：结构体指针，传出SdioFuncInfo信息 | HDF_STATUS相关状态 | 获取CommonInfo，说明见下 | 73| setCommonInfo | dev：结构体指针，SDIO设备控制器<br>info：联合体指针，SdioFuncInfo信息传入<br>infoType：uint32_t，info类型 | 无 | HDF_STATUS相关状态 | 设置CommonInfo，说明见下 | 74| flushData | dev：结构体指针，SDIO设备控制器 | 无 | HDF_STATUS相关状态 | 当SDIO需要重新初始化或发生意外错误时调用的函数 | 75| enableFunc | dev：结构体指针，SDIO设备控制器 | 无 | HDF_STATUS相关状态 | 使能SDIO设备 | 76| disableFunc | dev：结构体指针，SDIO设备控制器 | 无 | HDF_STATUS相关状态 | 去使能SDIO设备 | 77| claimIrq | dev：结构体指针，SDIO设备控制器<br>irqHandler：void函数指针 | 无 | HDF_STATUS相关状态 | 注册SDIO中断 | 78| releaseIrq | dev：结构体指针，SDIO设备控制器 | 无 | HDF_STATUS相关状态 | 释放SDIO中断 | 79| findFunc | dev：结构体指针，SDIO设备控制器<br>configData：结构体指针，SDIO函数关键信息 | 无 | HDF_STATUS相关状态 | 寻找匹配的funcNum | 80| claimHost | dev：结构体指针，SDIO设备控制器 | 无 | HDF_STATUS相关状态 | 独占HOST | 81| releaseHost | dev：结构体指针，SDIO设备控制器 | 无 | HDF_STATUS相关状态 | 释放HOST | 82 83 84>  **说明：**<br> 85> CommonInfo包括maxBlockNum（单个request中最大block数）、maxBlockSize（单个block最大字节数）、maxRequestSize（单个Request最大字节数）、enTimeout（最大超时时间，毫秒）、funcNum（功能编号1~7）、irqCap（IRQ capabilities）、(void \*)data。 86 87 88### 开发步骤 89 90SDIO模块适配HDF框架的三个必选环节是实例化驱动入口，配置属性文件，以及实例化SDIO控制器对象。 91 921. 实例化驱动入口 93 - 实例化HdfDriverEntry结构体成员。 94 - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。 95 962. 配置属性文件 97 - 在device_info.hcs文件中添加deviceNode描述。 98 - 【可选】添加sdio_config.hcs器件属性文件。 99 1003. 实例化SDIO控制器对象 101 - 初始化SdioDevice成员。 102 - 实例化SdioDevice成员SdioDeviceOps。 103 >  **说明：**<br> 104 > 实例化SdioDevice成员SdioDeviceOps，其定义和成员说明见[接口说明](#接口说明)。 105 1064. 驱动调试 107 108 【可选】针对新增驱动程序，建议验证驱动基本功能，例如SDIO控制状态，中断响应情况等。 109 110### 开发实例 111 112下方将以sdio_adapter.c为示例，展示需要驱动适配者提供哪些内容来完整实现设备功能。 113 1141. 驱动开发首先需要实例化驱动入口。 115 116 驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。 117 118 HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 119 120 一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 121 122 SDIO 驱动入口参考： 123 124 ```c 125 struct HdfDriverEntry g_sdioDriverEntry = { 126 .moduleVersion = 1, 127 .Bind = Hi35xxLinuxSdioBind, // 见Bind开发参考 128 .Init = Hi35xxLinuxSdioInit, // 见Init开发参考 129 .Release = Hi35xxLinuxSdioRelease, // 见Release开发参考 130 .moduleName = "HDF_PLATFORM_SDIO", // 【必要且与HCS文件中里面的moduleName匹配】 131 }; 132 /* 调用HDF_INIT将驱动入口注册到HDF框架中 */ 133 HDF_INIT(g_sdioDriverEntry); 134 ``` 135 1362. 完成驱动入口注册之后，下一步请在//vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode信息，并在sdio_config.hcs中配置器件属性。 137 138 deviceNode信息与驱动入口注册相关，器件属性值与核心层SdioDevice成员的默认值或限制范围有密切关系。 139 140 本例只有一个SDIO控制器，如有多个器件信息，则需要在device_info.hcs文件增加deviceNode信息，以及在sdio_config文件中增加对应的器件属性。 141 142 - device_info.hcs 配置参考： 143 144 ```c 145 root { 146 device_info { 147 match_attr = "hdf_manager"; 148 platform :: host { 149 hostName = "platform_host"; 150 priority = 50; 151 device_sdio :: device { 152 device0 :: deviceNode { 153 policy = 1; 154 priority = 70; 155 permission = 0644; 156 moduleName = "HDF_PLATFORM_SDIO"; // 【必要】用于指定驱动名称，需要与驱动Entry中的moduleName一致。 157 serviceName = "HDF_PLATFORM_MMC_2"; // 【必要】驱动对外发布服务的名称，必须唯一。 158 deviceMatchAttr = "hisilicon_hi35xx_sdio_0"; // 【必要】用于配置控制器私有数据，要与sdio_config.hcs中对应控制器保持一致。 159 } 160 } 161 } 162 } 163 } 164 ``` 165 166 - sdio_config.hcs 配置参考： 167 168 169 ```c 170 root { 171 platform { 172 sdio_config { 173 template sdio_controller { 174 match_attr = ""; 175 hostId = 2; // 【必要】模式固定为2，在mmc_config.hcs有介绍。 176 devType = 2; // 【必要】模式固定为2，在mmc_config.hcs有介绍。 177 } 178 controller_0x2dd1 :: sdio_controller { 179 match_attr = "hisilicon_hi35xx_sdio_0"; // 【必要】需要和device_info.hcs中的deviceMatchAttr值一致。 180 } 181 } 182 } 183 ``` 184 185 需要注意的是，新增sdio_config.hcs配置文件后，必须在hdf.hcs文件中将其包含，否则配置文件无法生效。 186 187 例如：本例中sdio_config.hcs所在路径为device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/sdio/sdio_config.hcs，则必须在产品对应的hdf.hcs中添加如下语句： 188 189 ```c 190 #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/sdio/sdio_config.hcs" // 配置文件相对路径 191 ``` 192 1933. 完成属性文件配置之后，下一步就是以核心层SdioDevice对象的初始化为核心，包括驱动适配者自定义结构体（传递参数和数据），实例化SdioDevice成员SdioDeviceOps（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。 194 195 - 自定义结构体参考： 196 197 从驱动的角度看，自定义结构体是参数和数据的载体，而且sdio_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象。 198 199 ```c 200 typedef struct { 201 uint32_t maxBlockNum; // 单个request最大的block个数 202 uint32_t maxBlockSize; // 单个block最大的字节数1~2048 203 uint32_t maxRequestSize; // 单个request最大的字节数1~2048 204 uint32_t enTimeout; // 最大超时时间，单位毫秒，且不能超过一秒。 205 uint32_t funcNum; // 函数编号1~7 206 uint32_t irqCap; // 中断能力 207 void *data; // 私有数据 208 } SdioFuncInfo; 209 210 /* SdioDevice是核心层控制器结构体，其中的成员在Bind函数中会被赋值。 */ 211 struct SdioDevice { 212 struct SdDevice sd; 213 struct SdioDeviceOps *sdioOps; 214 struct SdioRegister sdioReg; 215 uint32_t functions; 216 struct SdioFunction *sdioFunc[SDIO_MAX_FUNCTION_NUMBER]; 217 struct SdioFunction *curFunction; 218 struct OsalThread thread; // 中断线程 219 struct OsalSem sem; 220 bool irqPending; 221 bool threadRunning; 222 }; 223 ``` 224 225 - SdioDevice成员钩子函数结构体SdioDeviceOps的实例化，其他成员在Init函数中初始化。 226 227 ```c 228 static struct SdioDeviceOps g_sdioDeviceOps = { 229 .incrAddrReadBytes = Hi35xxLinuxSdioIncrAddrReadBytes, 230 .incrAddrWriteBytes = Hi35xxLinuxSdioIncrAddrWriteBytes, 231 .fixedAddrReadBytes = Hi35xxLinuxSdioFixedAddrReadBytes, 232 .fixedAddrWriteBytes = Hi35xxLinuxSdioFixedAddrWriteBytes, 233 .func0ReadBytes = Hi35xxLinuxSdioFunc0ReadBytes, 234 .func0WriteBytes = Hi35xxLinuxSdioFunc0WriteBytes, 235 .setBlockSize = Hi35xxLinuxSdioSetBlockSize, 236 .getCommonInfo = Hi35xxLinuxSdioGetCommonInfo, 237 .setCommonInfo = Hi35xxLinuxSdioSetCommonInfo, 238 .flushData = Hi35xxLinuxSdioFlushData, 239 .enableFunc = Hi35xxLinuxSdioEnableFunc, 240 .disableFunc = Hi35xxLinuxSdioDisableFunc, 241 .claimIrq = Hi35xxLinuxSdioClaimIrq, 242 .releaseIrq = Hi35xxLinuxSdioReleaseIrq, 243 .findFunc = Hi35xxLinuxSdioFindFunc, 244 .claimHost = Hi35xxLinuxSdioClaimHost, 245 .releaseHost = Hi35xxLinuxSdioReleaseHost, 246 }; 247 ``` 248 249 - Bind函数开发参考 250 251 入参： 252 253 HdfDeviceObject是整个驱动对外提供的接口参数，具备HCS配置文件的信息。 254 255 返回值： 256 257 HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。 258 259 **表2** Bind函数入参及返回值 260 261 | 状态(值) | 问题描述 | 262 | -------- | -------- | 263 | HDF_ERR_INVALID_OBJECT | 控制器对象非法 | 264 | HDF_ERR_MALLOC_FAIL | 内存分配失败 | 265 | HDF_ERR_INVALID_PARAM | 参数非法 | 266 | HDF_ERR_IO | I/O 错误 | 267 | HDF_SUCCESS | 初始化成功 | 268 | HDF_FAILURE | 初始化失败 | 269 270 函数说明： 271 272 初始化自定义结构体对象，初始化SdioCntlr成员，调用核心层SdioCntlrAdd函数，以及其他驱动适配者自定义初始化操作。 273 274 275 ```c 276 static int32_t Hi35xxLinuxSdioBind(struct HdfDeviceObject *obj) 277 { 278 struct MmcCntlr *cntlr = NULL; 279 int32_t ret; 280 ... 281 cntlr = (struct MmcCntlr *)OsalMemCalloc(sizeof(struct MmcCntlr));// 分配内存 282 ... 283 cntlr->ops = &g_sdioCntlrOps; //【必要】struct MmcCntlrOps g_sdioCntlrOps={ 284 // .rescanSdioDev = Hi35xxLinuxSdioRescan,}; 285 cntlr->hdfDevObj = obj; //【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 286 obj->service = &cntlr->service; //【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 287 ret = Hi35xxLinuxSdioCntlrParse(cntlr, obj); //【必要】初始化cntlr的index、devType，失败则goto _ERR。 288 ... 289 ret = MmcCntlrAdd(cntlr); //【必要】调用核心层mmc_core.c的函数，失败则goto _ERR。 290 ... 291 ret = MmcCntlrAllocDev(cntlr, (enum MmcDevType)cntlr->devType); //【必要】调用核心层mmc_core.c的函数，失败则goto _ERR。 292 ... 293 294 MmcDeviceAddOps(cntlr->curDev, &g_sdioDeviceOps); //【必要】调用核心层mmc_core.c的函数，钩子函数挂载。 295 HDF_LOGD("Hi35xxLinuxSdioBind: Success!"); 296 return HDF_SUCCESS; 297 298 _ERR: 299 Hi35xxLinuxSdioDeleteCntlr(cntlr); 300 HDF_LOGE("Hi35xxLinuxSdioBind: Fail!"); 301 return HDF_FAILURE; 302 } 303 ``` 304 305 - Init函数开发参考 306 307 入参： 308 309 HdfDeviceObject是整个驱动对外提供的接口参数，具备HCS配置文件的信息。 310 311 返回值： 312 313 HDF_STATUS相关状态。 314 315 函数说明： 316 317 无操作，可根据驱动适配者需要添加。 318 319 320 ```c 321 static int32_t Hi35xxLinuxSdioInit(struct HdfDeviceObject *obj) 322 { 323 (void)obj; // 无操作，可根据驱动适配者的需要进行添加 324 HDF_LOGD("Hi35xxLinuxSdioInit: Success!"); 325 return HDF_SUCCESS; 326 } 327 ``` 328 - Release函数开发参考 329 330 入参： 331 332 HdfDeviceObject是整个驱动对外提供的接口参数，具备HCS配置文件的信息。 333 334 返回值： 335 336 无。 337 338 函数说明： 339 340 释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。 341 342 >  **说明：**<br> 343 > 所有强制转换获取相应对象的操作前提是在Bind函数中具备对应赋值的操作。 344 345 ```c 346 static void Hi35xxLinuxSdioRelease(struct HdfDeviceObject *obj) 347 { 348 if (obj == NULL) { 349 return; 350 } 351 Hi35xxLinuxSdioDeleteCntlr((struct MmcCntlr *)obj->service); // 【必要】自定义的内存释放函数，这里有HdfDeviceObject到MmcCntlr的强制转换 352 } 353 ```
