diff --git a/zh-cn/device-dev/driver/driver-platform-mmc-develop.md b/zh-cn/device-dev/driver/driver-platform-mmc-develop.md index b0624652da2a2948344a5ba0a8d7e55e6a375be9..f1ecd21a8ba4317a2fe93646ea936ba702e05913 100755 --- a/zh-cn/device-dev/driver/driver-platform-mmc-develop.md +++ b/zh-cn/device-dev/driver/driver-platform-mmc-develop.md @@ -58,23 +58,24 @@ struct MmcCntlrOps { ## 开发步骤 -MMC模块适配的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。 +MMC模块适配的三个必选环节是实例化驱动入口，配置属性文件，以及实例化核心层接口函数。 -1. **实例化驱动入口：** +1. 实例化驱动入口 - 实例化HdfDriverEntry结构体成员。 - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。 -2. **配置属性文件：** +2. 配置属性文件 - 在device_info.hcs文件中添加deviceNode描述。 - 【可选】添加mmc_config.hcs器件属性文件。 -3. **实例化MMC控制器对象：** +3. 实例化MMC控制器对象 - 初始化MmcCntlr成员。 - 实例化MmcCntlr成员MmcCntlrOps。 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 实例化MmcCntlr成员MmcCntlrOps，其定义和成员说明见[接口说明](#接口说明)。 -4. **驱动调试：** +4. 驱动调试 + 【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，设备启动是否成功等。 @@ -82,7 +83,9 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， 下方将以himci.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释放驱动资源并退出。 @@ -99,8 +102,12 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， HDF_INIT(g_mmcDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中 ``` -2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在mmc_config.hcs中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层MmcCntlr成员的默认值或限制范围有密切关系。 - 如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在mmc_config文件中增加对应的器件属性**。** +2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在mmc_config.hcs中配置器件属性。 + + deviceNode信息与驱动入口注册相关，器件属性值与核心层MmcCntlr成员的默认值或限制范围有密切关系。 + + 如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在mmc_config文件中增加对应的器件属性。 + - device_info.hcs 配置参考 @@ -116,9 +123,9 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， policy = 2; priority = 10; permission = 0644; - moduleName = "hi3516_mmc_driver"; // 【必要】用于指定驱动名称，需要与驱动Entry中的moduleName一致； - serviceName = "HDF_PLATFORM_MMC_0"; // 【必要】驱动对外发布服务的名称，必须唯一 - deviceMatchAttr = "hi3516_mmc_emmc";// 【必要】用于配置控制器私有数据，要与 mmc_config.hcs 中对应控制器保持一致 + moduleName = "hi3516_mmc_driver"; // 【必要】用于指定驱动名称，需要与驱动Entry中的moduleName一致。 + serviceName = "HDF_PLATFORM_MMC_0"; // 【必要】驱动对外发布服务的名称，必须唯一。 + deviceMatchAttr = "hi3516_mmc_emmc";// 【必要】用于配置控制器私有数据，要与mmc_config.hcs中对应控制器保持一致。 } device1 :: deviceNode { policy = 1; @@ -149,7 +156,7 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， root { platform { mmc_config { - template mmc_controller {// 模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省 + template mmc_controller { // 模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。 match_attr = ""; voltDef = 0; // 3.3V freqMin = 50000; // 【必要】最小频率值 @@ -158,13 +165,13 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， maxBlkNum = 2048; // 【必要】最大的block号 maxBlkSize = 512; // 【必要】最大的block个数 ocrDef = 0x300000; // 【必要】工作电压设置相关 - caps2 = 0; // 【必要】属性寄存器相关，见mmc_caps.h中MmcCaps2定义 + caps2 = 0; // 【必要】属性寄存器相关，见mmc_caps.h中MmcCaps2定义。 regSize = 0x118; // 【必要】寄存器位宽 hostId = 0; // 【必要】主机号 regBasePhy = 0x10020000;// 【必要】寄存器物理基地址 irqNum = 63; // 【必要】中断号 - devType = 2; // 【必要】模式选择：emmc, SD, SDIO ,COMBO - caps = 0x0001e045; // 【必要】属性寄存器相关，见mmc_caps.h 中 MmcCaps 定义 + devType = 2; // 【必要】模式选择：emmc、SD、SDIO、COMBO + caps = 0x0001e045; // 【必要】属性寄存器相关，见mmc_caps.h中MmcCaps 定义。 } controller_0x10100000 :: mmc_controller { match_attr = "hi3516_mmc_emmc";// 【必要】需要和device_info.hcs中的deviceMatchAttr值一致 @@ -196,16 +203,17 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， } ``` -3. 完成驱动入口注册之后，最后一步就是以核心层MmcCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化MmcCntlr成员MmcCntlrOps（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。 +3. 完成驱动入口注册之后，下一步就是以核心层MmcCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化MmcCntlr成员MmcCntlrOps（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。 + - 自定义结构体参考 - 从驱动的角度看，自定义结构体是参数和数据的载体，而且mmc_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员 ，一些重要数值也会传递给核心层对象。 + 从驱动的角度看，自定义结构体是参数和数据的载体，而且mmc_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象。 ``` struct HimciHost { struct MmcCntlr *mmc;// 【必要】核心层结构体 - struct MmcCmd *cmd; // 【必要】核心层结构体，传递命令的，相关命令见枚举量 MmcCmdCode + struct MmcCmd *cmd; // 【必要】核心层结构体，传递命令的，相关命令见枚举量MmcCmdCode。 // 【可选】根据厂商驱动需要添加 void *base; enum HimciPowerStatus powerStatus; @@ -223,7 +231,7 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， bool waitForEvent; HIMCI_EVENT himciEvent; }; - // MmcCntlr是核心层控制器结构体，其中的成员在bind函数中会被赋值 + // MmcCntlr是核心层控制器结构体，其中的成员在Bind函数中会被赋值。 struct MmcCntlr { struct IDeviceIoService service; struct HdfDeviceObject *hdfDevObj; @@ -276,13 +284,13 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， ``` - Bind函数参考 - 入参**：** + 入参： - HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。 + HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。 返回值： - HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。 + HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 | 状态(值) | 问题描述 | | -------- | -------- | @@ -295,7 +303,7 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， 函数说明： - MmcCntlr，HimciHost，HdfDeviceObject之间互相赋值，方便其他函数可以相互转化，初始化自定义结构体HimciHost对象，初始化MmcCntlr成员，调用核心层MmcCntlrAdd函数。 + MmcCntlr、HimciHost、HdfDeviceObject之间互相赋值，方便其他函数可以相互转化，初始化自定义结构体HimciHost对象，初始化MmcCntlr成员，调用核心层MmcCntlrAdd函数。 ``` @@ -307,18 +315,18 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， cntlr = (struct MmcCntlr *)OsalMemCalloc(sizeof(struct MmcCntlr)); host = (struct HimciHost *)OsalMemCalloc(sizeof(struct HimciHost)); - host->mmc = cntlr; // 【必要】使HimciHost与MmcCntlr可以相互转化的前提 - cntlr->priv = (void *)host; // 【必要】使HimciHost与MmcCntlr可以相互转化的前提 - cntlr->ops = &g_himciHostOps; // 【必要】MmcCntlrOps的实例化对象的挂载 - cntlr->hdfDevObj = obj; // 【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 - obj->service = &cntlr->service; // 【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 - ret = MmcCntlrParse(cntlr, obj); // 【必要】 初始化 cntlr，失败就goto _ERR; + host->mmc = cntlr; // 【必要】使HimciHost与MmcCntlr可以相互转化的前提 + cntlr->priv = (void *)host; // 【必要】使HimciHost与MmcCntlr可以相互转化的前提 + cntlr->ops = &g_himciHostOps; // 【必要】MmcCntlrOps的实例化对象的挂载 + cntlr->hdfDevObj = obj; // 【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 + obj->service = &cntlr->service; // 【必要】使HdfDeviceObject与MmcCntlr可以相互转化的前提 + ret = MmcCntlrParse(cntlr, obj); // 【必要】 初始化cntlr，失败就goto _ERR。 ... - ret = HimciHostParse(host, obj); // 【必要】 初始化host对象的相关属性，失败就goto _ERR; + ret = HimciHostParse(host, obj); // 【必要】 初始化host对象的相关属性，失败就goto _ERR。 ... - ret = HimciHostInit(host, cntlr);// 厂商自定义的初始化，失败就 goto _ERR; + ret = HimciHostInit(host, cntlr); // 厂商自定义的初始化，失败就goto _ERR。 ... - ret = MmcCntlrAdd(cntlr); // 调用核心层函数 失败就goto _ERR; + ret = MmcCntlrAdd(cntlr); // 调用核心层函数，失败就goto _ERR。 ... (void)MmcCntlrAddDetectMsgToQueue(cntlr);// 将卡检测消息添加到队列中。 HDF_LOGD("HimciMmcBind: success."); @@ -334,7 +342,7 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， 入参： - HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。 + HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。 返回值： @@ -364,7 +372,7 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， 入参： - HdfDeviceObject 是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。 + HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。 返回值： @@ -372,7 +380,11 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， 函数说明： - 释放内存和删除控制器等操作，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用 Release释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。 + 释放内存和删除控制器等操作，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用 Release释放驱动资源。 + + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+ > 所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。 + ``` @@ -380,8 +392,8 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口， { struct MmcCntlr *cntlr = NULL; ... - cntlr = (struct MmcCntlr *)obj->service;// 这里有HdfDeviceObject到MmcCntlr的强制转化，通过service成员，赋值见Bind函数 + cntlr = (struct MmcCntlr *)obj->service; // 这里有HdfDeviceObject到MmcCntlr的强制转化，通过service成员，赋值见Bind函数。 ... - HimciDeleteHost((struct HimciHost *)cntlr->priv);// 厂商自定义的内存释放函数，这里有MmcCntlr到HimciHost的强制转化 + HimciDeleteHost((struct HimciHost *)cntlr->priv);// 厂商自定义的内存释放函数，这里有MmcCntlr到HimciHost的强制转化。 } ```