马上注册,结交更多好友,享用更多功能,让你轻松玩转社区。
您需要 登录 才可以下载或查看,没有账号?立即注册
×
OpenHarmony平台驱动开辟(十)
MMC
概述
功能简介
MMC(MultiMedia Card)即多媒体卡,是一种用于固态非易失性存储的小体积大容量的快闪存储卡。
MMC后续泛指一个接口协定(一种卡式),能符合这种接口的内存器都可称作MMC储存体。告急包罗几个部门:MMC控制器、MMC总线、存储卡(包罗MMC卡、SD卡、SDIO卡、TF卡)。
MMC、SD、SDIO总线,其总线规范类似,都是从MMC总线规范演化而来的。MMC夸大的是多媒体存储;SD夸大的是安全和数据掩护;SDIO是从SD演化出来的,夸大的是接口,不再关注另一端的详细形态(可以是WIFI装备、Bluetooth装备、GPS等等)。
基本概念
- SD卡(Secure Digital Memory Card)
SD卡即安全数码卡。它是在MMC的底子上发展而来,SD卡夸大数据的安全,可以设定存储内容的使用权限,防止数据被他人复制。在数据传输和物理规范上,SD卡(24mm*32mm*2.1mm,比MMC卡更厚一点),向前兼容了MMC卡。所有支持SD卡的装备也支持MMC卡。
- SDIO(Secure Digital Input and Output)
即安全数字输入输出接口。SDIO是在SD规范的尺度上界说的一种外设接口,它相较于SD规范增长了低速尺度,可以用最小的硬件开销支持低速I/O。SDIO接口兼容从前的SD内存卡,也可以毗连SDIO接口的装备。
运作机制
在HDF框架中,MMC的接口适配模式采用独立服务模式(如图1所示)。在这种模式下,每一个装备对象会独立发布一个装备服务来处理外部访问,装备管理器收到API的访问哀求之后,通过提取该哀求的参数,到达调用实际装备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理本事,但必要为每个装备单独设置装备节点,增长内存占用。
独立服务模式下,核心层不会同一发布一个服务供上层使用,因此这种模式下驱动要为每个控制器发布一个服务,详细表现为:
- 驱动适配者必要实现HdfDriverEntry的Bind钩子函数以绑定服务。
- device_info.hcs文件中deviceNode的policy字段为1或2,不能为0。
MMC模块各分层作用:
- 接口层提供打开MMC装备、查抄MMC控制器是否存在装备、关闭MMC装备的接口。
- 核心层告急提供MMC控制器、移除和管理的本事,还有公共控制器业务。通过钩子函数与适配层交互。
- 适配层告急是将钩子函数的功能实例化,实现详细的功能。
图 1 MMC独立服务模式结构图
开辟指导
场景先容
MMC用于多媒体文件的存储,当驱动开辟者必要将MMC装备适配到OpenHarmony时,必要举行MMC驱动适配。下文将先容怎样举行MMC驱动适配。
接口分析
为了包管上层在调用MMC接口时可以或许正确的操纵MMC控制器,核心层在//drivers/hdf_core/framework/model/storage/include/mmc/mmc_corex.h中界说了以下钩子函数,驱动适配者必要在适配层实现这些函数的详细功能,并与钩子函数挂接,从而完成适配层与核心层的交互。
MmcCntlrOps界说:- struct MmcCntlrOps {
- int32_t (*request)(struct MmcCntlr *cntlr, struct MmcCmd *cmd);
- int32_t (*setClock)(struct MmcCntlr *cntlr, uint32_t clock);
- int32_t (*setPowerMode)(struct MmcCntlr *cntlr, enum MmcPowerMode mode);
- int32_t (*setBusWidth)(struct MmcCntlr *cntlr, enum MmcBusWidth width);
- int32_t (*setBusTiming)(struct MmcCntlr *cntlr, enum MmcBusTiming timing);
- int32_t (*setSdioIrq)(struct MmcCntlr *cntlr, bool enable);
- int32_t (*hardwareReset)(struct MmcCntlr *cntlr);
- int32_t (*systemInit)(struct MmcCntlr *cntlr);
- int32_t (*setEnhanceStrobe)(struct MmcCntlr *cntlr, bool enable);
- int32_t (*switchVoltage)(struct MmcCntlr *cntlr, enum MmcVolt volt);
- bool (*devReadOnly)(struct MmcCntlr *cntlr);
- bool (*devPlugged)(struct MmcCntlr *cntlr);
- bool (*devBusy)(struct MmcCntlr *cntlr);
- int32_t (*tune)(struct MmcCntlr *cntlr, uint32_t cmdCode);
- int32_t (*rescanSdioDev)(struct MmcCntlr *cntlr);
- };
复制代码 表 1 MmcCntlrOps结构体成员的钩子函数功能分析
成员函数入参返回值功能doRequestcntlr:结构体指针,核心层MMC控制器
cmd:结构体指针,传入命令值HDF_STATUS相关状态request相应处理setClockcntlr:结构体指针,核心层MMC控制器
clock:uint32_t类型,时钟传入值HDF_STATUS相关状态设置时钟频率setPowerModecntlr:结构体指针,核心层MMC控制器
mode:枚举值(见MmcPowerMode界说),功耗模式HDF_STATUS相关状态设置功耗模式setBusWidthcntlr:核心层结构体指针,核心层MMMC控制器
width:枚举类型(见MmcBusWidth界说),总线带宽HDF_STATUS相关状态设置总线带宽setBusTimingcntlr:结构体指针,核心层MMC控制器
timing:枚举类型(见MmcBusTiming界说),总线时序HDF_STATUS相关状态设置总线时序setSdioIrqcntlr:结构体指针,核心层MMC控制器
enable:布尔值,控制中断HDF_STATUS相关状态使能/去使能SDIO中断hardwareResetcntlr:结构体指针,核心层MMC控制器HDF_STATUS相关状态复位硬件systemInitcntlr:结构体指针,核心层MMC控制器HDF_STATUS相关状态体系初始化setEnhanceStrobecntlr:结构体指针,核心层MMC控制器
enable:布尔值,设置功能HDF_STATUS相关状态设置加强选通switchVoltagecntlr:结构体指针,核心层MMC控制器
volt:枚举值,电压值(3.3,1.8,1.2V)HDF_STATUS相关状态设置电压值devReadOnlycntlr:结构体指针,核心层MMC控制器布尔值查验装备是否只读cardPluggedcntlr:结构体指针,核心层MMC控制器布尔值查验装备是否拔出devBusycntlr:结构体指针,核心层MMC控制器布尔值查验装备是否繁忙tunecntlr:结构体指针,核心层MMC控制器
cmdCode:uint32_t类型,命令代码HDF_STATUS相关状态调谐rescanSdioDevcntlr:结构体指针,核心层MMC控制器HDF_STATUS相关状态扫描并添加SDIO装备开辟步调
MMC模块适配包罗以下四个步调:
- 实例化驱动入口
- 设置属性文件
- 实例化MMC控制器对象
- 驱动调试
开辟实例
下方将基于Hi3516DV300开辟板以//device/soc/hisilicon/common/platform/mmc/himci_v200/himci.c驱动为示例,展示必要驱动适配者提供哪些内容来完备实现装备功能。
- 实例化驱动入口
驱动入口必须为HdfDriverEntry(在hdf_device_desc.h中界说)类型的全局变量,且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地点汇总,形成一个类似数组的段地点空间,方便上层调用。
一样平常在加载驱动时HDF会先调用Bind函数,再调用Init函数加载该驱动。当Init调用非常时,HDF框架会调用Release释放驱动资源并退出。
MMC驱动入口开辟参考:
- struct HdfDriverEntry g_mmcDriverEntry = {
- .moduleVersion = 1,
- .Bind = HimciMmcBind, // 见Bind参考
- .Init = HimciMmcInit, // 见Init参考
- .Release = HimciMmcRelease, // 见Release参考
- .moduleName = "hi3516_mmc_driver", // 【必要且与HCS文件中里面的moduleName匹配】
- };
- HDF_INIT(g_mmcDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中
复制代码 - 设置属性文件
完成驱动入口注册之后,必要在device_info.hcs文件中添加deviceNode信息,deviceNode信息与驱动入口注册相关。本例以三个MMC控制器为例,如有多个器件信息,则必要在device_info.hcs文件增长对应的deviceNode信息,以及在mmc_config.hcs文件中增长对应的器件属性。器件属性值与核心层MmcCntlr成员的默认值或限制范围有密切关系,必要在mmc_config.hcs中设置器件属性。
独立服务模式的特点是device_info.hcs文件中装备节点代表着一个装备对象,如果存在多个装备对象,则按需添加,留意服务名与驱动私有数据匹配的关键字名称必须唯一。此中各项参数如表2所示:
表 2 device_info.hcs节点参数分析
成员名值policy驱动服务发布的战略,MMC控制用详细设置为2,表示驱动对内核态和用户态都发布服务priority驱动启动优先级(0-200),值越大优先级越低。MMC控制器控制用详细设置为10permission驱动创建装备节点权限,MMC控制器控制用详细设置为0664moduleName驱动名称,MMC控制器控制器固定为hi3516_mmc_driverserviceName驱动对外发布服务的名称,MMC控制器控制器服务名设置为HDF_PLATFORM_MMC_X,X代表MMC控制器号deviceMatchAttr驱动私有数据匹配的关键字,MMC控制器控制器设置为hi3516_mmc_X,X代表控制器类型名
- device_info.hcs 设置参考:
在//vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode形貌。
- root {
- device_info {
- match_attr = "hdf_manager";
- platform :: host {
- hostName = "platform_host";
- priority = 50;
- device_mmc:: device {
- device0 :: deviceNode { // 驱动的DeviceNode节点
- policy = 2; // policy字段是驱动服务发布的策略,如果需要面向用户态,则为2
- priority = 10; // 驱动启动优先级
- permission = 0644; // 驱动创建设备节点权限
- moduleName = "hi3516_mmc_driver"; // 【必要】用于指定驱动名称,需要与驱动Entry中的moduleName一致。
- serviceName = "HDF_PLATFORM_MMC_0"; // 【必要】驱动对外发布服务的名称,必须唯一。
- deviceMatchAttr = "hi3516_mmc_emmc"; // 【必要】用于配置控制器私有数据,要与mmc_config.hcs中对应控制器保持一致。emmc类型。
- }
- device1 :: deviceNode {
- policy = 1;
- priority = 20;
- permission = 0644;
- moduleName = "hi3516_mmc_driver";
- serviceName = "HDF_PLATFORM_MMC_1";
- deviceMatchAttr = "hi3516_mmc_sd"; // SD类型
- }
- device2 :: deviceNode {
- policy = 1;
- priority = 30;
- permission = 0644;
- moduleName = "hi3516_mmc_driver";
- serviceName = "HDF_PLATFORM_MMC_2";
- deviceMatchAttr = "hi3516_mmc_sdio"; // SDIO类型
- }
- ......
- }
- }
- }
- }
复制代码 - mmc_config.hcs设置参考:
在//device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/mmc/mmc_config.hcs文件设置器件属性,此中设置参数如下:
- root {
- platform {
- mmc_config {
- template mmc_controller { // 配置模板,如果下面节点使用时继承该模板,则节点中未声明的字段会使用该模板中的默认值。
- match_attr = "";
- voltDef = 0; // MMC默认电压,0代表3.3V,1代表1.8V,2代表1.2V
- freqMin = 50000; // 【必要】最小频率值
- freqMax = 100000000; // 【必要】最大频率值
- freqDef = 400000; // 【必要】默认频率值
- maxBlkNum = 2048; // 【必要】最大的block号
- maxBlkSize = 512; // 【必要】最大block大小
- ocrDef = 0x300000; // 【必要】工作电压设置相关
- 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定义。
- }
- controller_0x10100000 :: mmc_controller {
- match_attr = "hi3516_mmc_emmc"; // 【必要】需要和device_info.hcs中的deviceMatchAttr值一致
- hostId = 0;
- regBasePhy = 0x10100000;
- irqNum = 96;
- devType = 0; // eMMC类型
- caps = 0xd001e045;
- caps2 = 0x60;
- }
- controller_0x100f0000 :: mmc_controller {
- match_attr = "hi3516_mmc_sd";
- hostId = 1;
- regBasePhy = 0x100f0000;
- irqNum = 62;
- devType = 1; // SD类型
- caps = 0xd001e005;
- }
- controller_0x10020000 :: mmc_controller {
- match_attr = "hi3516_mmc_sdio";
- hostId = 2;
- regBasePhy = 0x10020000;
- irqNum = 63;
- devType = 2; // SDIO类型
- caps = 0x0001e04d;
- }
- }
- }
- }
复制代码 必要留意的是,新增mmc_config.hcs设置文件后,必须在产品对应的hdf.hcs文件中将其包罗如下语句所示,否则设置文件无法见效。
- #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/mmc/mmc_config.hcs" // 配置文件相对路径
复制代码
- 实例化MMC控制器对象
完成设置属性文件之后,下一步就是以核心层MmcCntlr对象的初始化为核心,包罗驱动适配自界说结构体(通报参数和数据),实例化MmcCntlr成员MmcCntlrOps(让用户可以通过接口来调用驱动底层函数),实现HdfDriverEntry成员函数(Bind、Init、Release)。
- 驱动适配者自界说结构体参考。
从驱动的角度看,自界说结构体是参数和数据的载体,而且mmc_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员,一些告急数值也会通报给核心层对象。
- struct HimciHost {
- struct MmcCntlr *mmc; // 【必要】核心层控制对象
- struct MmcCmd *cmd; // 【必要】核心层结构体,传递命令,相关命令见枚举量MmcCmdCode
- void *base; // 地址映射需要,寄存器基地址
- enum HimciPowerStatus powerStatus;
- uint8_t *alignedBuff;
- uint32_t buffLen;
- struct scatterlist dmaSg;
- struct scatterlist *sg;
- uint32_t dmaSgNum;
- DMA_ADDR_T dmaPaddr;
- uint32_t *dmaVaddr;
- uint32_t irqNum;
- bool isTuning;
- uint32_t id;
- struct OsalMutex mutex;
- bool waitForEvent;
- HIMCI_EVENT himciEvent;
- };
- // MmcCntlr是核心层控制器结构体,其中的成员在Bind函数中会被赋值。
- struct MmcCntlr {
- struct IDeviceIoService service;
- struct HdfDeviceObject *hdfDevObj;
- struct PlatformDevice device;
- struct OsalMutex mutex;
- struct OsalSem released;
- uint32_t devType;
- struct MmcDevice *curDev;
- struct MmcCntlrOps *ops;
- struct PlatformQueue *msgQueue;
- uint16_t index;
- uint16_t voltDef;
- uint32_t vddBit;
- uint32_t freqMin;
- uint32_t freqMax;
- uint32_t freqDef;
- union MmcOcr ocrDef;
- union MmcCaps caps;
- union MmcCaps2 caps2;
- uint32_t maxBlkNum;
- uint32_t maxBlkSize;
- uint32_t maxReqSize;
- bool devPlugged;
- bool detecting;
- void *priv;
- };
复制代码 - MmcCntlr成员钩子函数结构体MmcCntlrOps的实例化。
- static struct MmcCntlrOps g_himciHostOps = {
- .request = HimciDoRequest,
- .setClock = HimciSetClock,
- .setPowerMode = HimciSetPowerMode,
- .setBusWidth = HimciSetBusWidth,
- .setBusTiming = HimciSetBusTiming,
- .setSdioIrq = HimciSetSdioIrq,
- .hardwareReset = HimciHardwareReset,
- .systemInit = HimciSystemInit,
- .setEnhanceStrobe = HimciSetEnhanceStrobe,
- .switchVoltage = HimciSwitchVoltage,
- .devReadOnly = HimciDevReadOnly,
- .devPlugged = HimciCardPlugged,
- .devBusy = HimciDevBusy,
- .tune = HimciTune,
- .rescanSdioDev = HimciRescanSdioDev,
- };
复制代码 - Bind函数开辟参考。
入参:
HdfDeviceObject:HDF框架给每一个驱动创建的装备对象,用来生存装备相关的私有数据和服务接口。
返回值:
HDF_STATUS相关状态(表3为部门展示,如需使用其他状态,可参考//drivers/hdf_core/interfaces/inner_api/utils/hdf_base.h中HDF_STATUS的界说)。
表 3 HDF_STATUS相关状态分析
状态(值)标题形貌HDF_ERR_INVALID_OBJECT控制器对象非法HDF_ERR_MALLOC_FAIL内存分配失败HDF_ERR_INVALID_PARAM参数非法HDF_ERR_IOI/O 错误HDF_SUCCESS初始化乐成HDF_FAILURE初始化失败 函数分析: MmcCntlr、HimciHost、HdfDeviceObject之间相互赋值,方便其他函数可以相互转化,初始化自界说结构体HimciHost对象,初始化MmcCntlr成员,调用核心层MmcCntlrAdd函数,完成MMC控制器的添加。
- static int32_t HimciMmcBind(struct HdfDeviceObject *obj)
- {
- struct MmcCntlr *cntlr = NULL;
- struct HimciHost *host = NULL;
- int32_t ret;
- 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。
- ......
- ret = HimciHostParse(host, obj); // 【必要】 初始化host对象的相关属性,失败就goto _ERR。
- ......
- ret = HimciHostInit(host, cntlr); // 驱动适配者自定义的初始化,失败就goto _ERR。
- ......
- ret = MmcCntlrAdd(cntlr); // 调用核心层函数,失败就goto _ERR。
- ......
- (void)MmcCntlrAddDetectMsgToQueue(cntlr); // 将卡检测消息添加到队列中。
- HDF_LOGD("HimciMmcBind: success.");
- return HDF_SUCCESS;
- ERR:
- HimciDeleteHost(host);
- HDF_LOGD("HimciMmcBind: fail, err = %d.", ret);
- return ret;
- }
复制代码 - Init函数开辟参考。
入参:
HdfDeviceObject:HDF框架给每一个驱动创建的装备对象,用来生存装备相关的私有数据和服务接口。
返回值:
HDF_STATUS相关状态。
函数分析:
实现ProcMciInit。
- static int32_t HimciMmcInit(struct HdfDeviceObject *obj)
- {
- static bool procInit = false;
- (void)obj;
- if (procInit == false) {
- if (ProcMciInit() == HDF_SUCCESS) {
- procInit = true;
- HDF_LOGD("HimciMmcInit: proc init success.");
- }
- }
- HDF_LOGD("HimciMmcInit: success.");
- return HDF_SUCCESS;
- }
复制代码 - Release函数开辟参考。
入参:
HdfDeviceObject:HDF框架给每一个驱动创建的装备对象,用来生存装备相关的私有数据和服务接口。
返回值:
无。
函数分析:
释放内存和删除控制器等操纵,该函数必要在驱动入口结构体中赋值给Release接口,当HDF框架调用Init函数初始化驱动失败时,可以调用Release释放驱动资源。
分析:
所有欺压转换获取相应对象的操纵条件是在Init函数中具备对应赋值的操纵。
- static void HimciMmcRelease(struct HdfDeviceObject *obj)
- {
- struct MmcCntlr *cntlr = NULL;
- ......
- cntlr = (struct MmcCntlr *)obj->service; // 这里有HdfDeviceObject到MmcCntlr的强制转化,通过service成员,赋值见Bind函数。
- ......
- HimciDeleteHost((struct HimciHost *)cntlr->priv); // 驱动适配者自定义的内存释放函数,这里有MmcCntlr到HimciHost的强制转化。
- }
复制代码
- 驱动调试
【可选】针对新增驱动步伐,发起验证驱动基本功能,比方挂载后的信息反馈,数据读写乐成与否等。
|