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