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