1# MIPI-DSI 2 3- [概述](#1) 4- [开发步骤](#2) 5- [开发实例](#3) 6 7## 概述 <a name="1"></a> 8 9DSI（Display Serial Interface）是由移动行业处理器接口联盟（Mobile Industry Processor Interface \(MIPI\) Alliance）制定的规范。在HDF框架中， 10MIPI-DSI的接口适配模式采用无服务模式，用于不需要在用户态提供API的设备类型，或者没有用户态和内核区分的OS系统，其关联方式是DevHandle直接指向设备对象内核态地址（DevHandle是一个void类型指针）。 11 12图 1 无服务模式结构图 13 14 15## 开发步骤 <a name="2"></a> 16 17MIPI-DSI模块适配的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。 18 191. **实例化驱动入口：** 20 21 - 实例化HdfDriverEntry结构体成员。 22 - 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。 23 242. **配置属性文件：** 25 26 - 在device_info.hcs文件中添加deviceNode描述。 27 - 【可选】添加mipidsi_config.hcs器件属性文件。 28 293. **实例化MIPIDSI控制器对象：** 30 31 - 初始化MipiDsiCntlr成员。 32 - 实例化MipiDsiCntlr成员MipiDsiCntlrMethod，其定义和成员**说明**见下 33 344. **驱动调试：** 35 - 【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，数据传输的成功与否等。 36 37>  **说明：** 38> 39> MipiDsiCntlrMethod定义 40> 41> ```c 42> struct MipiDsiCntlrMethod { // 核心层结构体的成员函数 43> int32_t (*setCntlrCfg)(struct MipiDsiCntlr *cntlr); 44> int32_t (*setCmd)(struct MipiDsiCntlr *cntlr, struct DsiCmdDesc *cmd); 45> int32_t (*getCmd)(struct MipiDsiCntlr *cntlr, struct DsiCmdDesc *cmd, uint32_t readLen, uint8_t *out); 46> void (*toHs)(struct MipiDsiCntlr *cntlr); 47> void (*toLp)(struct MipiDsiCntlr *cntlr); 48> void (*enterUlps)(struct MipiDsiCntlr *cntlr);//【可选】进入超低功耗模式 49> void (*exitUlps)(struct MipiDsiCntlr *cntlr); //【可选】退出超低功耗模式 50> int32_t (*powerControl)(struct MipiDsiCntlr *cntlr, uint8_t enable);//【可选】使能/去使能功耗控制 51> int32_t (*attach)(struct MipiDsiCntlr *cntlr);//【可选】将一个DSI设备连接上host 52> }; 53> ``` 54> 55> 表1 MipiDsiCntlrMethod成员的回调函数功能说明 56> |成员函数|入参|出参|返回状态|功能| 57> |-|-|-|-|-| 58> |setCntlrCfg | **cntlr**: 结构体指针，MipiDsi控制器 ; | 无 |HDF_STATUS相关状态 | 设置控制器参数 | 59> |setCmd | **cntlr**: 结构体指针，MipiDsi控制器 ;<br />**cmd**: 结构体指针,指令传入值|无|HDF_STATUS相关状态| 向显示设备发送指令 | 60> |getCmd | **cntlr**: 结构体指针，MipiDsi控制器 ; |**cmd**: 结构体指针,<br />用于传出指令值;|HDF_STATUS相关状态|从显示设备读取信息指令 | 61> |toHs | **cntlr**: 结构体指针，MipiDsi控制器 ; | 无 |HDF_STATUS相关状态 |设置为高速模式| 62> |toLp | **cntlr**: 结构体指针，MipiDsi控制器 ; | 无 |HDF_STATUS相关状态 |设置为低电模式 | 63 64## 开发实例 <a name="3"></a> 65 66下方将以mipi_tx_hi35xx.c为示例，展示需要厂商提供哪些内容来完整实现设备功能。 67 68 691. 一般来说，驱动开发首先需要在 xx_config.hcs 中配置器件属性，并在device_info.hcs文件中添加deviceNode描述。器件属性值与核心层MipiDsiCntlr 成员的默认值或限制范围有密切关系，deviceNode信息与驱动入口注册相关。 70 71 **但本例中MIPI控制器无需配置额外属性，如有厂商需要，则需要在device_info文件的deviceNode增加deviceMatchAttr信息，以及增加mipidsi_config文件**。 72 73- device_info.hcs 配置参考 74 75 ```c 76 root { 77 device_info { 78 match_attr = "hdf_manager"; 79 platform :: host { 80 hostName = "platform_host"; 81 priority = 50; 82 device_mipi_dsi:: device { 83 device0 :: deviceNode { 84 policy = 0; 85 priority = 150; 86 permission = 0644; 87 moduleName = "HDF_MIPI_TX"; //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致； 88 serviceName = "HDF_MIPI_TX"; // 【必要且唯一】驱动对外发布服务的名称 89 } 90 } 91 } 92 } 93 } 94 ``` 95 962. 完成器件属性文件的配置之后，下一步请实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HdfDriverEntry结构体的函数指针成员会被厂商操作函数填充，HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组，方便调用。 97 98 一般在加载驱动时HDF框架会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 99 100- MIPI-DSI驱动入口参考 101 102 ```c 103 struct HdfDriverEntry g_mipiTxDriverEntry = { 104 .moduleVersion = 1, 105 .Init = Hi35xxMipiTxInit, //见Init参考 106 .Release = Hi35xxMipiTxRelease,//见Release参考 107 .moduleName = "HDF_MIPI_TX", //【必要】需要与device_info.hcs 中保持一致。 108 }; 109 HDF_INIT(g_mipiTxDriverEntry); //调用HDF_INIT将驱动入口注册到HDF框架中 110 ``` 111 1123. 完成驱动入口注册之后，最后一步就是以核心层MipiDsiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化MipiDsiCntlr成员MipiDsiCntlrMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release） 113 114- 自定义结构体参考 115 116 > 从驱动的角度看，自定义结构体是参数和数据的载体，一般来说，config文件中的数值也会用来初始化结构体成员，但本例的mipidsi无器件属性文件，故基本成员结构与MipiDsiCntlr无太大差异。 117 118 ```c 119 typedef struct { 120 unsigned int devno; // 设备号 121 short laneId[LANE_MAX_NUM]; // lane号 122 OutPutModeTag outputMode; // 输出模式选择:刷新模式，命令行模式和视频流模式 123 VideoModeTag videoMode; // 显示设备的同步模式 124 OutputFormatTag outputFormat; // 输出DSI图像数据格式:RGB or YUV 125 SyncInfoTag syncInfo; // 时序相关的设置 126 unsigned int phyDataRate; // mbps 127 unsigned int pixelClk; // KHz 128 } ComboDevCfgTag; 129 130 // MipiDsiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值 131 struct MipiDsiCntlr { 132 struct IDeviceIoService service; 133 struct HdfDeviceObject *device; 134 unsigned int devNo; // 设备号 135 struct MipiCfg cfg; 136 struct MipiDsiCntlrMethod *ops; 137 struct OsalMutex lock; 138 void *priv; 139 }; 140 ``` 141 142- **【重要】** MipiDsiCntlr成员回调函数结构体MipiDsiCntlrMethod的实例化，其他成员在Init函数中初始化 143 144 ```c 145 static struct MipiDsiCntlrMethod g_method = { 146 .setCntlrCfg = Hi35xxSetCntlrCfg, 147 .setCmd = Hi35xxSetCmd, 148 .getCmd = Hi35xxGetCmd, 149 .toHs = Hi35xxToHs, 150 .toLp = Hi35xxToLp, 151 }; 152 ``` 153 154- **Init函数参考** 155 156 > **入参：** 157 > HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息 158 > 159 > **返回值：** 160 > HDF_STATUS相关状态 （下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义） 161 > 162 > |状态(值)|问题描述| 163 > |:-|:-:| 164 > |HDF_ERR_INVALID_OBJECT | 无效对象 | 165 > |HDF_ERR_MALLOC_FAIL |内存分配失败| 166 > |HDF_ERR_INVALID_PARAM |无效参数| 167 > |HDF_ERR_IO |I/O 错误| 168 > |HDF_SUCCESS |执行成功| 169 > |HDF_FAILURE |执行失败| 170 > 171 > **函数说明：** 172 > MipiDsiCntlrMethod的实例化对象的挂载，调用MipiDsiRegisterCntlr，以及其他厂商自定义初始化操作 173 174 ```c 175 static int32_t Hi35xxMipiTxInit(struct HdfDeviceObject *device) 176 { 177 int32_t ret; 178 g_mipiTx.priv = NULL; //g_mipiTx是定义的全局变量 179 //static struct MipiDsiCntlr g_mipiTx { 180 // .devNo=0 181 //}; 182 g_mipiTx.ops = &g_method;//MipiDsiCntlrMethod的实例化对象的挂载 183 ret = MipiDsiRegisterCntlr(&g_mipiTx, device);//【必要】调用核心层函数和g_mipiTx初始化核心层全局变量 184 ... 185 return MipiTxDrvInit(0); //【必要】厂商对设备的初始化，形式不限 186 } 187 188 //mipi_dsi_core.c核心层 189 int32_t MipiDsiRegisterCntlr(struct MipiDsiCntlr *cntlr, struct HdfDeviceObject *device) 190 { 191 ... 192 //定义的全局变量:static struct MipiDsiHandle g_mipiDsihandle[MAX_CNTLR_CNT]; 193 if (g_mipiDsihandle[cntlr->devNo].cntlr == NULL) { 194 (void)OsalMutexInit(&g_mipiDsihandle[cntlr->devNo].lock); 195 (void)OsalMutexInit(&(cntlr->lock)); 196 197 g_mipiDsihandle[cntlr->devNo].cntlr = cntlr;//初始化MipiDsiHandle成员 198 g_mipiDsihandle[cntlr->devNo].priv = NULL; 199 cntlr->device = device; //使HdfDeviceObject与MmcCntlr可以相互转化的前提 200 device->service = &(cntlr->service); //使HdfDeviceObject与MmcCntlr可以相互转化的前提 201 cntlr->priv = NULL; 202 ... 203 return HDF_SUCCESS; 204 } 205 ... 206 return HDF_FAILURE; 207 } 208 ``` 209 210- **Release函数参考** 211 212 > **入参：** 213 > HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息 214 > 215 > **返回值：** 216 > 无 217 > 218 > **函数说明：** 219 > 该函数需要在驱动入口结构体中赋值给 Release 接口， 当 HDF 框架调用 Init 函数初始化驱动失败时，可以调用 Release 释放驱动资源， 该函数中需包含释放内存和删除控制器等操作。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。 220 221 ```c 222 static void Hi35xxMipiTxRelease(struct HdfDeviceObject *device) 223 { 224 struct MipiDsiCntlr *cntlr = NULL; 225 ... 226 cntlr = MipiDsiCntlrFromDevice(device);//这里有HdfDeviceObject到MipiDsiCntlr的强制转化 227 //return (device == NULL) ? NULL : (struct MipiDsiCntlr *)device->service; 228 ... 229 MipiTxDrvExit(); //【必要】对厂商设备所占资源的释放 230 MipiDsiUnregisterCntlr(&g_mipiTx); //空函数 231 g_mipiTx.priv = NULL; 232 HDF_LOGI("%s: unload mipi_tx driver 1212!", __func__); 233 } 234 ``` 235 236
