diff --git a/zh-cn/device-dev/driver/driver-platform-sdio-develop.md b/zh-cn/device-dev/driver/driver-platform-sdio-develop.md index 9270200f585e72605bcc8dedda1f459730d2ffba..bd8a24365c64192e6abc03906022c298eb0df433 100755 --- a/zh-cn/device-dev/driver/driver-platform-sdio-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-sdio-develop.md @@ -3,7 +3,7 @@ ## 概述 -SDIO由SD卡发展而来，被统称为mmc（MultiMediaCard），相关技术差别不大。在HDF框架中，SDIO的接口适配模式采用独立服务模式。在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力，但需要为每个设备单独配置设备节点，增加内存占用。 +SDIO（Secure Digital Input and Output）由SD卡发展而来，被统称为MMC（MultiMediaCard），相关技术差别不大。在HDF框架中，SDIO的接口适配模式采用独立服务模式。在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力，但需要为每个设备单独配置设备节点，增加内存占用。 **图1** SDIO独立服务模式结构图 @@ -60,29 +60,31 @@ struct SdioDeviceOps { | claimHost | dev：结构体指针，SDIO设备控制器 | 无 | HDF_STATUS相关状态 | 独占HOST | | releaseHost | dev：结构体指针，SDIO设备控制器 | 无 | HDF_STATUS相关状态 | 释放HOST | + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
-> CommonInfo包括maxBlockNum（单个request中最大block数）， maxBlockSize（单个block最大字节数）， maxRequestSize（单个Request最大字节数）， enTimeout（最大超时时间，毫秒）， funcNum（功能编号1~7）， irqCap（IRQ capabilities）， (void \*)data. +> CommonInfo包括maxBlockNum（单个request中最大block数）、maxBlockSize（单个block最大字节数）、maxRequestSize（单个Request最大字节数）、enTimeout（最大超时时间，毫秒）、funcNum（功能编号1~7）、irqCap（IRQ capabilities）、(void \*)data。 ## 开发步骤 -SDIO模块适配HDF框架的三个环节是配置属性文件，实例化驱动入口，以及填充核心层接口函数。 +SDIO模块适配HDF框架的三个必选环节是实例化驱动入口，配置属性文件，以及填充核心层接口函数。 -1. **实例化驱动入口：** +1. 实例化驱动入口 - 实例化HdfDriverEntry结构体成员。 - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。 -2. **配置属性文件：** +2. 配置属性文件 - 在device_info.hcs文件中添加deviceNode描述。 - 【可选】添加sdio_config.hcs器件属性文件。 -3. **实例化SDIO控制器对象：** +3. 实例化SDIO控制器对象 - 初始化SdioDevice成员。 - 实例化SdioDevice成员SdioDeviceOps。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 实例化SdioDevice成员SdioDeviceOps，其定义和成员说明见[接口说明](#接口说明)。 -4. **驱动调试：** +4. 驱动调试 + 【可选】针对新增驱动程序，建议验证驱动基本功能，例如SDIO控制状态，中断响应情况等。 @@ -90,10 +92,15 @@ SDIO模块适配HDF框架的三个环节是配置属性文件，实例化驱动 下方将以sdio_adapter.c为示例，展示需要厂商提供哪些内容来完整实现设备功能。 -1. 驱动开发首先需要实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 +1. 驱动开发首先需要实例化驱动入口。 + + 驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。 + + HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 + 一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 - SDIO 驱动入口参考： + SDIO 驱动入口参考： ``` struct HdfDriverEntry g_sdioDriverEntry = { @@ -101,14 +108,18 @@ SDIO模块适配HDF框架的三个环节是配置属性文件，实例化驱动 .Bind = Hi35xxLinuxSdioBind, // 见Bind参考 .Init = Hi35xxLinuxSdioInit, // 见Init参考 .Release = Hi35xxLinuxSdioRelease,// 见Release参考 - .moduleName = "HDF_PLATFORM_SDIO",// 【必要，且与HCS文件中里面的moduleName匹配】 + .moduleName = "HDF_PLATFORM_SDIO",// 【必要且与HCS文件中里面的moduleName匹配】 }; // 调用HDF_INIT将驱动入口注册到HDF框架中 HDF_INIT(g_sdioDriverEntry); ``` -2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在 sdio_config.hcs 中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层SdioDevice成员的默认值或限制范围有密切关系。 - 本例只有一个SDIO控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在sdio_config文件中增加对应的器件属性。 +2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在sdio_config.hcs中配置器件属性。 + + deviceNode信息与驱动入口注册相关，器件属性值与核心层SdioDevice成员的默认值或限制范围有密切关系。 + + 本例只有一个SDIO控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在sdio_config文件中增加对应的器件属性。 + - device_info.hcs 配置参考： @@ -124,9 +135,9 @@ SDIO模块适配HDF框架的三个环节是配置属性文件，实例化驱动 policy = 1; priority = 70; permission = 0644; - moduleName = "HDF_PLATFORM_SDIO"; // 【必要】用于指定驱动名称，需要与驱动Entry中的moduleName一致； - serviceName = "HDF_PLATFORM_MMC_2"; // 【必要】驱动对外发布服务的名称，必须唯一 - deviceMatchAttr = "hisilicon_hi35xx_sdio_0";// 【必要】用于配置控制器私有数据，要与sdio_config.hcs中对应控制器保持一致 + moduleName = "HDF_PLATFORM_SDIO"; // 【必要】用于指定驱动名称，需要与驱动Entry中的moduleName一致。 + serviceName = "HDF_PLATFORM_MMC_2"; // 【必要】驱动对外发布服务的名称，必须唯一。 + deviceMatchAttr = "hisilicon_hi35xx_sdio_0";// 【必要】用于配置控制器私有数据，要与sdio_config.hcs中对应控制器保持一致。 } } } @@ -143,34 +154,35 @@ SDIO模块适配HDF框架的三个环节是配置属性文件，实例化驱动 sdio_config { template sdio_controller { match_attr = ""; - hostId = 2; // 【必要】模式固定为2，在mmc_config.hcs有介绍 - devType = 2; // 【必要】模式固定为2，在mmc_config.hcs有介绍 + hostId = 2; // 【必要】模式固定为2，在mmc_config.hcs有介绍。 + devType = 2; // 【必要】模式固定为2，在mmc_config.hcs有介绍。 } controller_0x2dd1 :: sdio_controller { - match_attr = "hisilicon_hi35xx_sdio_0";// 【必要】需要和device_info.hcs中的deviceMatchAttr值一致 + match_attr = "hisilicon_hi35xx_sdio_0";// 【必要】需要和device_info.hcs中的deviceMatchAttr值一致。 } } } ``` -3. 完成驱动入口注册之后，最后一步就是以核心层SdioDevice对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化SdioDevice成员SdioDeviceOps（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。 +3. 完成属性文件配置之后，下一步就是以核心层SdioDevice对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化SdioDevice成员SdioDeviceOps（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。 + - 自定义结构体参考： - 从驱动的角度看，自定义结构体是参数和数据的载体，而且sdio_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象。 + 从驱动的角度看，自定义结构体是参数和数据的载体，而且sdio_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象。 ``` typedef struct { uint32_t maxBlockNum; // 单个request最大的block个数 uint32_t maxBlockSize; // 单个block最大的字节数1~2048 - uint32_t maxRequestSize; // 单个request最大的字节数 1~2048 - uint32_t enTimeout; // 最大超时时间，单位毫秒，且不能超过一秒 + uint32_t maxRequestSize; // 单个request最大的字节数1~2048 + uint32_t enTimeout; // 最大超时时间，单位毫秒，且不能超过一秒。 uint32_t funcNum; // 函数编号1~7 uint32_t irqCap; // 中断能力 void *data; // 私有数据 } SdioFuncInfo; - // SdioDevice是核心层控制器结构体，其中的成员在Bind函数中会被赋值 + // SdioDevice是核心层控制器结构体，其中的成员在Bind函数中会被赋值。 struct SdioDevice { struct SdDevice sd; struct SdioDeviceOps *sdioOps; @@ -184,6 +196,7 @@ SDIO模块适配HDF框架的三个环节是配置属性文件，实例化驱动 bool threadRunning; }; ``` + - SdioDevice成员回调函数结构体SdioDeviceOps的实例化，其他成员在Init函数中初始化。 @@ -216,7 +229,8 @@ SDIO模块适配HDF框架的三个环节是配置属性文件，实例化驱动 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。 + **表2** Bind函数入参及返回值 | 状态(值) | 问题描述 | @@ -241,18 +255,18 @@ SDIO模块适配HDF框架的三个环节是配置属性文件，实例化驱动 ... cntlr = (struct MmcCntlr *)OsalMemCalloc(sizeof(struct MmcCntlr));// 分配内存 ... - cntlr->ops = &g_sdioCntlrOps; // 【必要】struct MmcCntlrOps g_sdioCntlrOps={ - // .rescanSdioDev = Hi35xxLinuxSdioRescan,}; - cntlr->hdfDevObj = obj; // 【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 - obj->service = &cntlr->service;// 【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 - ret = Hi35xxLinuxSdioCntlrParse(cntlr, obj);//【必要】初始化cntlr 的 index, devType, 失败则 goto _ERR; + cntlr->ops = &g_sdioCntlrOps; //【必要】struct MmcCntlrOps g_sdioCntlrOps={ + // .rescanSdioDev = Hi35xxLinuxSdioRescan,}; + cntlr->hdfDevObj = obj; //【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 + obj->service = &cntlr->service; //【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 + ret = Hi35xxLinuxSdioCntlrParse(cntlr, obj); //【必要】初始化cntlr的index、devType，失败则goto _ERR。 ... - ret = MmcCntlrAdd(cntlr); // 【必要】调用核心层mmc_core.c的函数， 失败则 goto _ERR; + ret = MmcCntlrAdd(cntlr); //【必要】调用核心层mmc_core.c的函数，失败则goto _ERR。 ... - ret = MmcCntlrAllocDev(cntlr, (enum MmcDevType)cntlr->devType);// 【必要】调用核心层mmc_core.c的函数， 失败则 goto _ERR; + ret = MmcCntlrAllocDev(cntlr, (enum MmcDevType)cntlr->devType); //【必要】调用核心层mmc_core.c的函数，失败则goto _ERR。 ... - MmcDeviceAddOps(cntlr->curDev, &g_sdioDeviceOps);// 【必要】调用核心层mmc_core.c的函数， 钩子函数挂载 + MmcDeviceAddOps(cntlr->curDev, &g_sdioDeviceOps); //【必要】调用核心层mmc_core.c的函数，钩子函数挂载。 HDF_LOGD("Hi35xxLinuxSdioBind: Success!"); return HDF_SUCCESS; @@ -298,8 +312,10 @@ SDIO模块适配HDF框架的三个环节是配置属性文件，实例化驱动 函数说明： - 释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给 Release 接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作前提是在Bind函数中具备对应赋值的操作。 + 释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > 所有强制转换获取相应对象的操作前提是在Bind函数中具备对应赋值的操作。 ``` static void Hi35xxLinuxSdioRelease(struct HdfDeviceObject *obj)