Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 a88454a6 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!7966 资料规范性检查（3），涉及翻译。 

Merge pull request !7966 from liyan/master
上级 ba32342e 90638dad
展开全部 隐藏空白更改
内联 并排
Showing with 445 addition and 343 deletion
zh-cn/device-dev/driver/driver-platform-mipidsi-develop.md
浏览文件 @ a88454a6
......@@ -22,10 +22,10 @@ struct MipiDsiCntlrMethod { // 核心层结构体的成员函数
int32_t (*getCmd)(struct MipiDsiCntlr *cntlr, struct DsiCmdDesc *cmd, uint32_t readLen, uint8_t *out);
void (*toHs)(struct MipiDsiCntlr *cntlr);
void (*toLp)(struct MipiDsiCntlr *cntlr);
void (*enterUlps)(struct MipiDsiCntlr *cntlr);// 【可选】进入超低功耗模式
void (*exitUlps)(struct MipiDsiCntlr *cntlr); // 【可选】退出超低功耗模式
void (*enterUlps)(struct MipiDsiCntlr *cntlr); //【可选】进入超低功耗模式
void (*exitUlps)(struct MipiDsiCntlr *cntlr); //【可选】退出超低功耗模式
int32_t (*powerControl)(struct MipiDsiCntlr *cntlr, uint8_t enable);//【可选】使能/去使能功耗控制
int32_t (*attach)(struct MipiDsiCntlr *cntlr);// 【可选】将一个DSI设备连接上host
int32_t (*attach)(struct MipiDsiCntlr *cntlr); //【可选】将一个DSI设备连接上host
};
```
......@@ -42,23 +42,24 @@ struct MipiDsiCntlrMethod { // 核心层结构体的成员函数
## 开发步骤
MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。
MIPI DSI模块适配的三个必选环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。
1. **实例化驱动入口：**
- 实例化HdfDriverEntry结构体成员。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
2. **配置属性文件：**
1. 配置属性文件
- 在device_info.hcs文件中添加deviceNode描述。
- 【可选】添加mipidsi_config.hcs器件属性文件。
3. **实例化MIPIDSI控制器对象：**
2. 实例化驱动入口
- 实例化HdfDriverEntry结构体成员。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
3. 实例化MIPIDSI控制器对象
- 初始化MipiDsiCntlr成员。
- 实例化MipiDsiCntlr成员MipiDsiCntlrMethod。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 实例化MipiDsiCntlr成员MipiDsiCntlrMethod，其定义和成员说明见[接口说明](#接口说明)。
4. **驱动调试：**
4. 驱动调试
【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，数据传输的成功与否等。
......@@ -66,7 +67,9 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
下方将以mipi_tx_hi35xx.c为示例，展示需要厂商提供哪些内容来完整实现设备功能。
1. 一般来说，驱动开发首先需要在xx_config.hcs中配置器件属性，并在device_info.hcs文件中添加deviceNode描述。器件属性值与核心层MipiDsiCntlr成员的默认值或限制范围有密切关系，deviceNode信息与驱动入口注册相关。
1. 一般来说，驱动开发首先需要在xx_config.hcs中配置器件属性，并在device_info.hcs文件中添加deviceNode描述。
器件属性值与核心层MipiDsiCntlr成员的默认值或限制范围有密切关系，deviceNode信息与驱动入口注册相关。
但本例中MIPI控制器无需配置额外属性，如有厂商需要，则需要在device_info文件的deviceNode增加deviceMatchAttr信息，以及增加mipidsi_config文件。
......@@ -84,8 +87,8 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
policy = 0;
priority = 150;
permission = 0644;
moduleName = "HDF_MIPI_TX"; // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致
serviceName = "HDF_MIPI_TX"; // 【必要且唯一】驱动对外发布服务的名称
moduleName = "HDF_MIPI_TX"; // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。
serviceName = "HDF_MIPI_TX"; // 【必要且唯一】驱动对外发布服务的名称。
}
}
}
......@@ -93,10 +96,13 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
}
```
2. 完成器件属性文件的配置之后，下一步请实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HdfDriverEntry结构体的函数指针成员会被厂商操作函数填充，HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组，方便调用。
2. 完成器件属性文件的配置之后，下一步请实例化驱动入口。
驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HdfDriverEntry结构体的函数指针成员会被厂商操作函数填充，HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组，方便调用。
一般在加载驱动时HDF框架会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。
- MIPI DSI驱动入口参考
MIPI DSI驱动入口参考：
```
struct HdfDriverEntry g_mipiTxDriverEntry = {
......@@ -108,7 +114,8 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
HDF_INIT(g_mipiTxDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中
```
3. 完成驱动入口注册之后，最后一步就是以核心层MipiDsiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化MipiDsiCntlr成员MipiDsiCntlrMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
3. 完成驱动入口注册之后，下一步就是以核心层MipiDsiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化MipiDsiCntlr成员MipiDsiCntlrMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。
- 自定义结构体参考
从驱动的角度看，自定义结构体是参数和数据的载体，一般来说，config文件中的数值也会用来初始化结构体成员，但本例的mipidsi无器件属性文件，故基本成员结构与MipiDsiCntlr无太大差异。
......@@ -118,7 +125,7 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
typedef struct {
unsigned int devno; // 设备号
short laneId[LANE_MAX_NUM]; // lane号
OutPutModeTag outputMode; // 输出模式选择:刷新模式，命令行模式和视频流模式
OutPutModeTag outputMode; // 输出模式选择：刷新模式，命令行模式或视频流模式
VideoModeTag videoMode; // 显示设备的同步模式
OutputFormatTag outputFormat; // 输出DSI图像数据格式：RGB或YUV
SyncInfoTag syncInfo; // 时序相关的设置
......@@ -126,7 +133,7 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
unsigned int pixelClk; // 时钟，单位KHz
} ComboDevCfgTag;
// MipiDsiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值
// MipiDsiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值。
struct MipiDsiCntlr {
struct IDeviceIoService service;
struct HdfDeviceObject *device;
......@@ -153,11 +160,11 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
入参：
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定义）。
| 状态(值) | 问题描述 |
......@@ -178,21 +185,21 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
static int32_t Hi35xxMipiTxInit(struct HdfDeviceObject *device)
{
int32_t ret;
g_mipiTx.priv = NULL; // g_mipiTx是定义的全局变量
// static struct MipiDsiCntlr g_mipiTx {
// .devNo=0
//};
g_mipiTx.ops = &g_method;// MipiDsiCntlrMethod的实例化对象的挂载
g_mipiTx.priv = NULL; // g_mipiTx是定义的全局变量
// static struct MipiDsiCntlr g_mipiTx {
// .devNo=0
//};
g_mipiTx.ops = &g_method; // MipiDsiCntlrMethod的实例化对象的挂载
ret = MipiDsiRegisterCntlr(&g_mipiTx, device);// 【必要】调用核心层函数和g_mipiTx初始化核心层全局变量
...
return MipiTxDrvInit(0); // 【必要】厂商对设备的初始化，形式不限
return MipiTxDrvInit(0); // 【必要】厂商对设备的初始化，形式不限
}
// mipi_dsi_core.c核心层
int32_t MipiDsiRegisterCntlr(struct MipiDsiCntlr *cntlr, struct HdfDeviceObject *device)
{
...
// 定义的全局变量:static struct MipiDsiHandle g_mipiDsihandle[MAX_CNTLR_CNT];
// 定义的全局变量：static struct MipiDsiHandle g_mipiDsihandle[MAX_CNTLR_CNT];
if (g_mipiDsihandle[cntlr->devNo].cntlr == NULL) {
(void)OsalMutexInit(&g_mipiDsihandle[cntlr->devNo].lock);
(void)OsalMutexInit(&(cntlr->lock));
......@@ -213,7 +220,7 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
入参：
HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
返回值：
......@@ -221,8 +228,10 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
函数说明：
该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源，该函数中需包含释放内存和删除控制器等操作。所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。
该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源，该函数中需包含释放内存和删除控制器等操作。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。
```
static void Hi35xxMipiTxRelease(struct HdfDeviceObject *device)
......@@ -230,7 +239,7 @@ MIPI DSI模块适配的三个环节是配置属性文件，实例化驱动入口
struct MipiDsiCntlr *cntlr = NULL;
...
cntlr = MipiDsiCntlrFromDevice(device);// 这里有HdfDeviceObject到MipiDsiCntlr的强制转化
// return (device == NULL) ? NULL : (struct MipiDsiCntlr *)device->service;
// return (device == NULL) ? NULL : (struct MipiDsiCntlr *)device->service;
...
MipiTxDrvExit(); // 【必要】对厂商设备所占资源的释放
MipiDsiUnregisterCntlr(&g_mipiTx); // 空函数
......
zh-cn/device-dev/driver/driver-platform-mmc-develop.md
浏览文件 @ a88454a6
......@@ -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) **说明：**<br>
> 实例化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) **说明：**<br>
> 所有强制转换获取相应对象的操作前提是在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的强制转化。
}
```
zh-cn/device-dev/driver/driver-platform-pin-develop.md
浏览文件 @ a88454a6
......@@ -61,12 +61,12 @@ struct PinCntlrMethod {
| 成员函数 | 入参 | 出参 | 返回值 | 功能 |
| ------------ | ------------------------------------------- | ------ | ---- | ---- |
| SetPinPull | **cntlr**：结构体指针，核心层Pin控制器<br>**index**：uint32_t变量，管脚索引号<br/>**pullType**：枚举常量，Pin管脚推拉方式 | 无 |HDF_STATUS相关状态|PIN设置管脚推拉方式|
| GetPinPull | **cntlr**：结构体指针，核心层Pin控制器<br/>**index**：uint32_t变量，管脚索引号 | **pullType**：枚举常量指针，传出Pin管脚推拉方式 | HDF_STATUS相关状态 | PIN获取管脚推拉方式 |
| SetPinStrength | **cntlr**：结构体指针，核心层Pin控制器<br/>**index**：uint32_t变量，管脚索引号<br/>**strength**：uint32_t变量，Pin推拉强度 | 无 | HDF_STATUS相关状态 | PIN设置推拉强度 |
| GetPinStrength | **cntlr**：结构体指针，核心层Pin控制器<br/>**index**：uint32_t变量，管脚索引号 | **strength**：uint32_t变量指针，传出Pin推拉强度 | HDF_STATUS相关状态 | PIN获取推拉强度 |
| SetPinFunc | **cntlr**：结构体指针，核心层Pin控制器<br/>**index**：uint32_t变量，管脚索引号<br/>**funcName**：char指针常量，传入Pin管脚功能 | 无 | HDF_STATUS相关状态 | PIN设置管脚功能 |
| GetPinFunc | **cntlr**：结构体指针，核心层Pin控制器<br/>**index**：uint32_t变量，管脚索引号 | **funcName**：char双重指针常量，传出Pin管脚功能 | HDF_STATUS相关状态 | PIN获取管脚功能 |
| SetPinPull | cntlr：结构体指针，核心层Pin控制器<br>index：uint32_t变量，管脚索引号<br/>pullType：枚举常量，Pin管脚推拉方式 | 无 |HDF_STATUS相关状态|PIN设置管脚推拉方式|
| GetPinPull | cntlr：结构体指针，核心层Pin控制器<br/>index：uint32_t变量，管脚索引号 | pullType：枚举常量指针，传出Pin管脚推拉方式 | HDF_STATUS相关状态 | PIN获取管脚推拉方式 |
| SetPinStrength | cntlr：结构体指针，核心层Pin控制器<br/>index：uint32_t变量，管脚索引号<br/>strength：uint32_t变量，Pin推拉强度 | 无 | HDF_STATUS相关状态 | PIN设置推拉强度 |
| GetPinStrength | cntlr：结构体指针，核心层Pin控制器<br/>index：uint32_t变量，管脚索引号 | strength：uint32_t变量指针，传出Pin推拉强度 | HDF_STATUS相关状态 | PIN获取推拉强度 |
| SetPinFunc | cntlr：结构体指针，核心层Pin控制器<br/>index：uint32_t变量，管脚索引号<br/>funcName：char指针常量，传入Pin管脚功能 | 无 | HDF_STATUS相关状态 | PIN设置管脚功能 |
| GetPinFunc | cntlr：结构体指针，核心层Pin控制器<br/>index：uint32_t变量，管脚索引号 | funcName：char双重指针常量，传出Pin管脚功能 | HDF_STATUS相关状态 | PIN获取管脚功能 |
### 开发步骤
......@@ -77,12 +77,14 @@ PIN模块适配包含以下四个步骤：
- 实例化核心层接口函数。
- 驱动调试。
1. **实例化驱动入口：**
1. 实例化驱动入口：
- 实例化HdfDriverEntry结构体成员。
驱动开发首先需要实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。
驱动开发首先需要实例化驱动入口，驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
一般在加载驱动时HDF会先调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。
```c
......@@ -93,11 +95,13 @@ PIN模块适配包含以下四个步骤：
.Release = Hi35xxPinRelease,
.moduleName = "hi35xx_pin_driver", // 【必要且与HCS文件中里面的moduleName匹配】
};
HDF_INIT(g_hi35xxPinDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中
HDF_INIT(g_hi35xxPinDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中
```
2. **配置属性文件：**
2. 配置属性文件：
- 在vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode描述。
```c
root {
device_info {
......@@ -105,13 +109,13 @@ PIN模块适配包含以下四个步骤：
hostName = "platform_host";
priority = 50;
device_pin :: device {
device0 :: deviceNode { // 为每一个Pin控制器配置一个HDF设备节点，存在多个时须添加，否则不用
policy = 0; // 2:用户态可见,1:内核态可见,0:不需要发布服务
device0 :: deviceNode { // 为每一个Pin控制器配置一个HDF设备节点，存在多个时须添加，否则不用。
policy = 0; // 2：用户态可见；1：内核态可见；0：不需要发布服务。
priority = 10; // 驱动启动优先级
permission = 0644; // 驱动创建设备节点权限
/* 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致 */
/* 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。 */
moduleName = "hi35xx_pin_driver";
/* 【必要】用于配置控制器私有数据，要与pin_config.hcs中对应控制器保持一致，具体的控制器信息在pin_config.hcs中 */
/* 【必要】用于配置控制器私有数据，要与pin_config.hcs中对应控制器保持一致，具体的控制器信息在pin_config.hcs中。 */
deviceMatchAttr = "hisilicon_hi35xx_pin_0";
}
device1 :: deviceNode {
......@@ -128,12 +132,13 @@ PIN模块适配包含以下四个步骤：
}
```
- 添加pin_config.hcs器件属性文件。
在device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/pin/pin_config.hcs目录下配置器件属性，其中配置参数如下：
```c
root {
platform {
pin_config_hi35xx {
template pin_controller { // 【必要】模板配置，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
template pin_controller { // 【必要】模板配置，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。
number = 0; // 【必要】controller编号
regStartBasePhy = 0; // 【必要】寄存器物理基地址起始地址
regSize = 0; // 【必要】寄存器位宽
......@@ -163,16 +168,18 @@ PIN模块适配包含以下四个步骤：
F1 = "SFC_CLK";
F2 = "SFC_BOOT_MODE";
}
...... // 对应管脚控制器下的每个管脚，按实际添加
...... // 对应管脚控制器下的每个管脚，按实际添加。
}
......// 每个管脚控制器对应一个controller节点，如存在多个Pin控制器，请依次添加对应的controller节点
......// 每个管脚控制器对应一个controller节点，如存在多个Pin控制器，请依次添加对应的controller节点。
}
}
}
```
3. **实例化PIN控制器对象：**
3. 实例化PIN控制器对象：
- 初始化PinCntlr成员。
在Hi35xxPinCntlrInit函数中对PinCntlr成员进行初始化操作。
```c
......@@ -208,7 +215,7 @@ PIN模块适配包含以下四个步骤：
uint32_t pinCount;
};
// PinCntlr是核心层控制器，其中的成员在init函数中会被赋值
// PinCntlr是核心层控制器，其中的成员在Init函数中会被赋值。
struct PinCntlr {
struct IDeviceIoService service;
struct HdfDeviceObject *device;
......@@ -253,7 +260,7 @@ PIN模块适配包含以下四个步骤：
HDF_LOGE("%s: read pinCount failed", __func__);
return ret;
}
// 将读取的值赋值给管脚控制器的成员，完成管脚控制器初始化
// 将读取的值赋值给管脚控制器的成员，完成管脚控制器初始化。
hi35xx->cntlr.pinCount = hi35xx->pinCount;
hi35xx->cntlr.number = hi35xx->number;
hi35xx->regBase = OsalIoRemap(hi35xx->regStartBasePhy, hi35xx->regSize); // 管脚控制器映射
......@@ -284,10 +291,12 @@ PIN模块适配包含以下四个步骤：
- Init函数
入参：
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定义）。
| **状态(值)** | **问题描述** |
| ---------------------- | -------------- |
......@@ -299,6 +308,7 @@ PIN模块适配包含以下四个步骤：
| HDF_FAILURE | 初始化失败 |
函数说明：
初始化自定义结构体对象和PinCntlr成员，并通过调用核心层PinCntlrAdd函数挂载Pin控制器。
```c
......@@ -360,7 +370,7 @@ PIN模块适配包含以下四个步骤：
ret = Hi35xxPinCntlrInit(device, hi35xx); // 管脚控制器初始化
......
DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) { // 遍历管脚控制器的每个子节点
ret = Hi35xxPinParsePinNode(childNode, hi35xx, index); // 解析子节点
ret = Hi35xxPinParsePinNode(childNode, hi35xx, index); // 解析子节点
......
}
......@@ -378,7 +388,7 @@ PIN模块适配包含以下四个步骤：
入参：
HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
返回值：
......@@ -424,5 +434,6 @@ PIN模块适配包含以下四个步骤：
}
}
```
4. **驱动调试：**
4. 驱动调试：
【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，数据传输的成功与否等。
\ No newline at end of file
zh-cn/device-dev/driver/driver-platform-pwm-develop.md
浏览文件 @ a88454a6
......@@ -27,30 +27,31 @@ struct PwmMethod {
| 成员函数 | 入参 | 返回值 | 功能 |
| -------- | -------- | -------- | -------- |
| setConfig | -**pwm**:&nbsp;&nbsp;结构体指针，核心层PWM控制器<br/>-**config**:&nbsp;&nbsp;结构体指针，属性传入值 | HDF_STATUS相关状态 | 配置属性 |
| open | **pwm**:&nbsp;&nbsp;结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 打开设备 |
| close | **pwm**:&nbsp;&nbsp;结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 关闭设备 |
| setConfig | pwm：结构体指针，核心层PWM控制器<br/>config：结构体指针，属性传入值 | HDF_STATUS相关状态 | 配置属性 |
| open | pwm：结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 打开设备 |
| close | pwm：结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 关闭设备 |
## 开发步骤
PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动入口，以及填充核心层接口函数。
PWM模块适配HDF框架的三个必选环节是实例化驱动入口，配置属性文件，以及填充核心层接口函数。
1. **实例化驱动入口：**
1. 实例化驱动入口
- 实例化HdfDriverEntry结构体成员。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
2. **配置属性文件：**
2. 配置属性文件
- 在device_info.hcs文件中添加deviceNode描述。
- 【可选】添加pwm_config.hcs器件属性文件。
3. **实例化PWM控制器对象：**
3. 实例化PWM控制器对象
- 初始化PwmDev成员。
- 实例化PwmDev成员PwmMethod。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 实例化PwmDev成员PwmMethod，其定义和成员说明见[接口说明](#接口说明)。
4. **驱动调试：**
4. 驱动调试
【可选】针对新增驱动程序，建议验证驱动基本功能，例如PWM控制状态，中断响应情况等。
......@@ -58,16 +59,20 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
下方将以pwm_hi35xx.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释放驱动资源并退出。
PWM驱动入口参考：
PWM驱动入口参考：
```
struct HdfDriverEntry g_hdfPwm = {
.moduleVersion = 1,
.moduleName = "HDF_PLATFORM_PWM",// 【必要，且与HCS文件中里面的moduleName匹配】
.moduleName = "HDF_PLATFORM_PWM",// 【必要且与HCS文件中里面的moduleName匹配】
.Bind = HdfPwmBind,
.Init = HdfPwmInit,
.Release = HdfPwmRelease,
......@@ -76,7 +81,10 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
HDF_INIT(g_hdfPwm);
```
2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在 pwm_config.hcs 中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层PwmDev成员的默认值或限制范围有密切关系。如有更多个器件信息，则需要在device_info文件增加deviceNode信息，以及在pwm_config文件中增加对应的器件属性。
2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在pwm_config.hcs中配置器件属性。
deviceNode信息与驱动入口注册相关，器件属性值与核心层PwmDev成员的默认值或限制范围有密切关系。如有更多个器件信息，则需要在device_info文件增加deviceNode信息，以及在pwm_config文件中增加对应的器件属性。
- device_info.hcs配置参考
......@@ -86,15 +94,15 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
platform :: host {
hostName = "platform_host";
priority = 50;
device_pwm :: device {// 为每一个pwm控制器配置一个HDF设备节点
device_pwm :: device { // 为每一个pwm控制器配置一个HDF设备节点
device0 :: deviceNode {
policy = 1; // 等于1，向内核态发布服务
priority = 80; // 驱动启动优先级
permission = 0644;// 驱动创建设备节点权限
moduleName = "HDF_PLATFORM_PWM"; // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
serviceName = "HDF_PLATFORM_PWM_0";// 【必要且唯一】驱动对外发布服务的名称
deviceMatchAttr = "hisilicon_hi35xx_pwm_0";// 【必要】用于配置控制器私有数据，要与 pwm_config.hcs 中对应
// 控制器保持一致，具体的控制器信息在 pwm_config.hcs 中
policy = 1; // 等于1，向内核态发布服务。
priority = 80; // 驱动启动优先级
permission = 0644; // 驱动创建设备节点权限
moduleName = "HDF_PLATFORM_PWM"; // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。
serviceName = "HDF_PLATFORM_PWM_0"; // 【必要且唯一】驱动对外发布服务的名称
deviceMatchAttr = "hisilicon_hi35xx_pwm_0";// 【必要】用于配置控制器私有数据，要与pwm_config.hcs中对应
// 控制器保持一致，具体的控制器信息在pwm_config.hcs中。
}
device1 :: deviceNode {
policy = 1;
......@@ -135,30 +143,31 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
}
```
3. 完成驱动入口注册之后，最后一步就是以核心层PwmDev对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化PwmDev成员PwmMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
3. 完成驱动入口注册之后，下一步就是以核心层PwmDev对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化PwmDev成员PwmMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。
- 自定义结构体参考。
从驱动的角度看，自定义结构体是参数和数据的载体，而且pwm_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号等。
从驱动的角度看，自定义结构体是参数和数据的载体，而且pwm_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号等。
```
struct HiPwm {
struct PwmDev dev; // 【必要】 核心层结构体
volatile unsigned char *base;
struct HiPwmRegs *reg; // 设备属性结构体，可自定义
struct HiPwmRegs *reg; // 设备属性结构体，可自定义。
bool supportPolarity;
};
// PwmDev是核心层控制器结构体，其中的成员在Init函数中会被赋值
// PwmDev是核心层控制器结构体，其中的成员在Init函数中会被赋值。
struct PwmDev {
struct IDeviceIoService service;
struct HdfDeviceObject *device;
struct PwmConfig cfg; // 属性结构体，相关定义见下
struct PwmConfig cfg; // 属性结构体，相关定义见下。
struct PwmMethod *method; // 钩子函数模板
bool busy;
uint32_t num; // 设备号
OsalSpinlock lock;
void *priv; // 私有数据，一般存储自定义结构体首地址，方便调用
void *priv; // 私有数据，一般存储自定义结构体首地址，方便调用。
};
struct PwmConfig {
uint32_t duty; // 占空时间 nanoseconds
......@@ -189,11 +198,11 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
入参：
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定义）。
| 状态(值) | 问题描述 |
| -------- | -------- |
......@@ -210,7 +219,7 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
```
// 此处bind函数为空函数，可与init函数结合，也可根据厂商需要实现相关操作
// 此处Bind函数为空函数，可与Init函数结合，也可根据厂商需要实现相关操作。
static int32_t HdfPwmBind(struct HdfDeviceObject *obj)
{
(void)obj;
......@@ -237,16 +246,16 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
iface = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE);//初始化自定义结构体HiPwm
...
hp->reg = (struct HiPwmRegs *)hp->base; // 初始化自定义结构体HiPwm
hp->supportPolarity = false; // 初始化自定义结构体HiPwm
hp->dev.method = &g_pwmOps; // PwmMethod的实例化对象的挂载
hp->dev.cfg.duty = PWM_DEFAULT_DUTY_CYCLE; // 初始化PwmDev
hp->dev.cfg.period = PWM_DEFAULT_PERIOD; // 初始化PwmDev
hp->dev.cfg.polarity = PWM_DEFAULT_POLARITY; // 初始化PwmDev
hp->dev.cfg.status = PWM_DISABLE_STATUS; // 初始化PwmDev
hp->dev.cfg.number = 0; // 初始化PwmDev
hp->dev.busy = false; // 初始化PwmDev
if (PwmDeviceAdd(obj, &(hp->dev)) != HDF_SUCCESS) {// 【重要】调用核心层函数，初始化hp->dev 的设备和服务
hp->reg = (struct HiPwmRegs *)hp->base; // 初始化自定义结构体HiPwm
hp->supportPolarity = false; // 初始化自定义结构体HiPwm
hp->dev.method = &g_pwmOps; // PwmMethod的实例化对象的挂载
hp->dev.cfg.duty = PWM_DEFAULT_DUTY_CYCLE; // 初始化PwmDev
hp->dev.cfg.period = PWM_DEFAULT_PERIOD; // 初始化PwmDev
hp->dev.cfg.polarity = PWM_DEFAULT_POLARITY; // 初始化PwmDev
hp->dev.cfg.status = PWM_DISABLE_STATUS; // 初始化PwmDev
hp->dev.cfg.number = 0; // 初始化PwmDev
hp->dev.busy = false; // 初始化PwmDev
if (PwmDeviceAdd(obj, &(hp->dev)) != HDF_SUCCESS) { // 【重要】调用核心层函数，初始化hp->dev的设备和服务。
OsalIoUnmap((void *)hp->base);
return HDF_FAILURE;
}
......@@ -265,7 +274,7 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
函数说明：
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口， 当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
```
......@@ -275,7 +284,7 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
...
hp = (struct HiPwm *)obj->service;// 这里有HdfDeviceObject到HiPwm的强制转化
...
PwmDeviceRemove(obj, &(hp->dev));// 【必要】调用核心层函数，释放PwmDev的设备和服务,这里有HiPwm到PwmDev的强制转化
HiPwmRemove(hp); // 释放HiPwm
PwmDeviceRemove(obj, &(hp->dev)); // 【必要】调用核心层函数，释放PwmDev的设备和服务，这里有HiPwm到PwmDev的强制转化。
HiPwmRemove(hp); // 释放HiPwm
}
```
zh-cn/device-dev/driver/driver-platform-regulator-develop.md
浏览文件 @ a88454a6
......@@ -61,17 +61,17 @@ struct RegulatorMethod {
| 成员函数 | 入参 | 返回值 | 功能 |
| ------------ | ----------------------------------------------------------- | ----------------- | ---------------- |
| open | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 打开设备 |
| close | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 关闭设备 |
| release | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 释放设备句柄 |
| enable | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 使能 |
| disable | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 禁用 |
| forceDisable | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 强制禁用 |
| setVoltage | **node**：结构体指针，核心层Regulator节点<br>**minUv**：uint32_t变量，最小电压<br>**maxUv**：uint32_t变量，最大电压 | HDF_STATUS相关状态 | 设置输出电压范围 |
| getVoltage | **node**：结构体指针，核心层Regulator节点<br>**voltage**：uint32_t指针，传出电压值 | HDF_STATUS相关状态 | 获取电压 |
| setCurrent | **node**：结构体指针，核心层Regulator节点<br>**minUa**：uint32_t变量，最小电流<br>**maxUa**：uint32_t变量，最大电流 | HDF_STATUS相关状态 | 设置输出电流范围 |
| getCurrent | **node**：结构体指针，核心层Regulator节点<br>**regCurrent**：uint32_t指针，传出电流值 | HDF_STATUS相关状态 | 获取电流 |
| getStatus | **node**：结构体指针，核心层Regulator节点<br>**status**：uint32_t指针，传出状态值 | HDF_STATUS相关状态 | 获取设备状态 |
| open | node：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 打开设备 |
| close | node：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 关闭设备 |
| release | node：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 释放设备句柄 |
| enable | node：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 使能 |
| disable | node：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 禁用 |
| forceDisable | node：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 强制禁用 |
| setVoltage | node：结构体指针，核心层Regulator节点<br>minUv：uint32_t变量，最小电压<br>maxUv：uint32_t变量，最大电压 | HDF_STATUS相关状态 | 设置输出电压范围 |
| getVoltage | node：结构体指针，核心层Regulator节点<br>voltage：uint32_t指针，传出电压值 | HDF_STATUS相关状态 | 获取电压 |
| setCurrent | node：结构体指针，核心层Regulator节点<br>minUa：uint32_t变量，最小电流<br>maxUa：uint32_t变量，最大电流 | HDF_STATUS相关状态 | 设置输出电流范围 |
| getCurrent | node：结构体指针，核心层Regulator节点<br>regCurrent：uint32_t指针，传出电流值 | HDF_STATUS相关状态 | 获取电流 |
| getStatus | node：结构体指针，核心层Regulator节点<br>status：uint32_t指针，传出状态值 | HDF_STATUS相关状态 | 获取设备状态 |
### 开发步骤
......@@ -82,9 +82,11 @@ Regulator模块适配包含以下四个步骤：
- 实例化核心层接口函数。
- 驱动调试。
1. **实例化驱动入口：**
1. 实例化驱动入口：
驱动开发首先需要实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。 HDF框架会汇总所有加载的驱动的HdfDriverEntry对象入口 ，形成一个类似数组的段地址空间，方便上层调用。
驱动开发首先需要实例化驱动入口，驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。
HDF框架会汇总所有加载的驱动的HdfDriverEntry对象入口，形成一个类似数组的段地址空间，方便上层调用。
一般在加载驱动时HDF会先调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。
......@@ -99,7 +101,7 @@ Regulator模块适配包含以下四个步骤：
HDF_INIT(g_regulatorDriverEntry);
```
2. **配置属性文件：**
2. 配置属性文件：
- 在vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode描述。
......@@ -127,14 +129,14 @@ Regulator模块适配包含以下四个步骤：
hostName = "platform_host";
priority = 50;
device_regulator :: device {
device0 :: deviceNode { // 为每一个Regulator控制器配置一个HDF设备节点，存在多个时添加，否则不用
policy = 1; // 2：用户态可见；1：内核态可见；0：不需要发布服务
priority = 50; // 驱动启动优先级
device0 :: deviceNode { // 为每一个Regulator控制器配置一个HDF设备节点，存在多个时添加，否则不用。
policy = 1; // 2：用户态可见；1：内核态可见；0：不需要发布服务。
priority = 50; // 驱动启动优先级
permission = 0644; // 驱动创建设备节点权限
/* 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致 */
/* 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。 */
moduleName = "HDF_PLATFORM_REGULATOR_MANAGER";
serviceName = "HDF_PLATFORM_REGULATOR_MANAGER"; //【必要且唯一】驱动对外发布服务的名称
/* 【必要】用于配置控制器私有数据，要与regulator_config.hcs中对应控制器保持一致，具体的控制器信息在regulator_config.hcs中 */
/* 【必要】用于配置控制器私有数据，要与regulator_config.hcs中对应控制器保持一致，具体的控制器信息在regulator_config.hcs中。 */
deviceMatchAttr = "hdf_platform_regulator_manager";
}
device1 :: deviceNode {
......@@ -157,7 +159,7 @@ Regulator模块适配包含以下四个步骤：
platform {
regulator_config {
match_attr = "linux_regulator_adapter";
template regulator_controller { // 【必要】模板配置，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
template regulator_controller { // 【必要】模板配置，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。
device_num = 1;
name = "";
devName = "regulator_adapter_consumer01";
......@@ -179,7 +181,7 @@ Regulator模块适配包含以下四个步骤：
minUa = 0;
maxUa = 0;
}
/* 每个Regulator控制器对应一个controller节点，如存在多个Regulator控制器，请依次添加对应的controller节点 */
/* 每个Regulator控制器对应一个controller节点，如存在多个Regulator控制器，请依次添加对应的controller节点。 */
controller_0x130d0001 :: regulator_controller {
device_num = 1;
name = "regulator_adapter_2";
......@@ -196,16 +198,16 @@ Regulator模块适配包含以下四个步骤：
}
```
3. **实例化核心层接口函数：**
3. 实例化核心层接口函数：
- 完成驱动入口注册之后，最后一步就是对核心层RegulatorNode对象的初始化，包括厂商自定义结构体（传递参数和数据），实例化RegulatorNode成员RegulatorMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
- 完成驱动入口注册之后，下一步就是对核心层RegulatorNode对象的初始化，包括厂商自定义结构体（传递参数和数据），实例化RegulatorNode成员RegulatorMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。
- 自定义结构体参考。
从驱动的角度看，RegulatorNode结构体是参数和数据的载体，HDF框架通过DeviceResourceIface将regulator\_config.hcs文件中的数值读入其中。
```
// RegulatorNode是核心层控制器结构体，其中的成员在Init函数中会被赋值
// RegulatorNode是核心层控制器结构体，其中的成员在Init函数中会被赋值。
struct RegulatorNode {
struct RegulatorDesc regulatorInfo;
struct DListHead node;
......@@ -215,17 +217,17 @@ Regulator模块适配包含以下四个步骤：
};
struct RegulatorDesc {
const char *name; /* regulator名称 */
const char *parentName; /* regulator父节点名称 */
const char *name; /* regulator名称 */
const char *parentName; /* regulator父节点名称 */
struct RegulatorConstraints constraints; /* regulator约束信息 */
uint32_t minUv; /* 最小输出电压值 */
uint32_t maxUv; /* 最大输出电压值 */
uint32_t minUa; /* 最小输出电流值 */
uint32_t maxUa; /* 最大输出电流值 */
uint32_t status; /* regulator的状态，开或关 */
uint32_t minUv; /* 最小输出电压值 */
uint32_t maxUv; /* 最大输出电压值 */
uint32_t minUa; /* 最小输出电流值 */
uint32_t maxUa; /* 最大输出电流值 */
uint32_t status; /* regulator的状态，开或关。*/
int useCount;
int consumerRegNums; /* regulator用户数量 */
RegulatorStatusChangecb cb; /* 当regulator状态改变时，可通过此变量通知 */
int consumerRegNums; /* regulator用户数量 */
RegulatorStatusChangecb cb; /* 当regulator状态改变时，可通过此变量通知。*/
};
struct RegulatorConstraints {
......@@ -261,11 +263,11 @@ Regulator模块适配包含以下四个步骤：
入参：
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定义）。
**表 2** HDF\_STATUS相关状态
......@@ -304,12 +306,12 @@ Regulator模块适配包含以下四个步骤：
regNode = (struct RegulatorNode *)OsalMemCalloc(sizeof(*regNode));//加载HCS文件
...
ret = VirtualRegulatorReadHcs(regNode, node);// 读取HCS文件信息
ret = VirtualRegulatorReadHcs(regNode, node); // 读取HCS文件信息
...
regNode->priv = (void *)node; // 实例化节点
regNode->ops = &g_method; // 实例化ops
regNode->priv = (void *)node; // 实例化节点
regNode->ops = &g_method; // 实例化ops
ret = RegulatorNodeAdd(regNode); // 挂载节点
ret = RegulatorNodeAdd(regNode); // 挂载节点
...
}
```
......@@ -318,7 +320,7 @@ Regulator模块适配包含以下四个步骤：
入参：
HdfDeviceObject是整个驱动对外暴露的接口参数，其包含了hcs配置文件中的相关配置信息。
HdfDeviceObject是整个驱动对外暴露的接口参数，其包含了HCS配置文件中的相关配置信息。
返回值：
......@@ -336,7 +338,7 @@ Regulator模块适配包含以下四个步骤：
}
```
4. **驱动调试：**
4. 驱动调试：
【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的测试用例是否成功等。
......
zh-cn/device-dev/driver/driver-platform-rtc-develop.md
浏览文件 @ a88454a6
......@@ -3,7 +3,7 @@
## 概述
RTC（real-time clock）为操作系统中的实时时钟设备。在HDF框架中，RTC的接口适配模式采用独立服务模式，在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力，但需要为每个设备单独配置设备节点，增加内存占用。
RTC（Real-time Clock）为操作系统中的实时时钟设备。在HDF框架中，RTC的接口适配模式采用独立服务模式，在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力，但需要为每个设备单独配置设备节点，增加内存占用。
**图1** RTC独立服务模式结构图
......@@ -50,23 +50,24 @@ struct RtcMethod {
## 开发步骤
RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动入口，以及填充核心层接口函数。
RTC模块适配HDF框架的三个必选环节是实例化驱动入口，配置属性文件，以及填充核心层接口函数。
1. **实例化驱动入口：**
1. 实例化驱动入口
- 实例化HdfDriverEntry结构体成员。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
2. **配置属性文件：**
2. 配置属性文件
- 在device_info.hcs文件中添加deviceNode描述。
- 【可选】添加rtc_config.hcs器件属性文件。
3. **实例化RTC控制器对象：**
3. 实例化RTC控制器对象
- 初始化RtcHost成员。
- 实例化RtcHost成员RtcMethod。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 实例化RtcHost成员RtcMethod，其定义和成员说明见[接口说明](#接口说明)。
4. **驱动调试：**
4. 驱动调试
【可选】针对新增驱动程序，建议验证驱动基本功能，例如RTC控制状态，中断响应情况等。
......@@ -74,10 +75,15 @@ RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动
下方将以rtc_hi35xx.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释放驱动资源并退出。
RTC驱动入口参考：
RTC驱动入口参考：
```
struct HdfDriverEntry g_rtcDriverEntry = {
......@@ -85,15 +91,19 @@ RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动
.Bind = HiRtcBind, // 见Bind参考
.Init = HiRtcInit, // 见Init参考
.Release = HiRtcRelease, // 见Release参考
.moduleName = "HDF_PLATFORM_RTC",// 【必要】且与 HCS 里面的名字匹配
.moduleName = "HDF_PLATFORM_RTC",// 【必要】且与HCS里面的名字匹配
};
//调用HDF_INIT将驱动入口注册到HDF框架中
HDF_INIT(g_rtcDriverEntry);
```
2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在 rtc_config.hcs 中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层RtcHost成员的默认值或限制范围有密切关系。
本例只有一个RTC控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在rtc_config文件中增加对应的器件属性。
- device_info.hcs 配置参考。
2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在rtc_config.hcs中配置器件属性。
deviceNode信息与驱动入口注册相关，器件属性值与核心层RtcHost成员的默认值或限制范围有密切关系。
本例只有一个RTC控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在rtc_config文件中增加对应的器件属性。
- device_info.hcs配置参考
```
......@@ -102,12 +112,12 @@ RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动
platform :: host {
device_rtc :: device {
device0 :: deviceNode {
policy = 1; // 2:用户态可见,1:内核态可见,0:不需要发布服务
priority = 30; // 值越小，优先级越高
policy = 1; // 2：用户态可见；1：内核态可见；0：不需要发布服务。
priority = 30; // 值越小，优先级越高。
permission = 0644; // 驱动创建设备节点权限
moduleName = "HDF_PLATFORM_RTC"; // 【必要】用于指定驱动名称，需要与驱动Entry中的moduleName一致
serviceName = "HDF_PLATFORM_RTC"; // 【必要】驱动对外发布服务的名称，必须唯一
deviceMatchAttr = "hisilicon_hi35xx_rtc";// 【必要】需要与设备hcs文件中的 match_attr 匹配
moduleName = "HDF_PLATFORM_RTC"; // 【必要】用于指定驱动名称，需要与驱动Entry中的moduleName一致。
serviceName = "HDF_PLATFORM_RTC"; // 【必要】驱动对外发布服务的名称，必须唯一。
deviceMatchAttr = "hisilicon_hi35xx_rtc";// 【必要】需要与设备hcs文件中的match_attr匹配。
}
}
}
......@@ -115,7 +125,7 @@ RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动
}
```
- rtc_config.hcs配置参考。
- rtc_config.hcs配置参考
```
......@@ -140,10 +150,11 @@ RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动
}
```
3. 完成驱动入口注册之后，最后一步就是以核心层RtcHost对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化RtcHost成员RtcMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
3. 完成属性文件配置之后，下一步就是以核心层RtcHost对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化RtcHost成员RtcMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。
- 自定义结构体参考。
从驱动的角度看，自定义结构体是参数和数据的载体，而且rtc_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员。
从驱动的角度看，自定义结构体是参数和数据的载体，而且rtc_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员。
```
......@@ -161,7 +172,7 @@ RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动
struct OsalMutex mutex; // 互斥锁
};
// RtcHost是核心层控制器结构体，其中的成员在Init函数中会被赋值
// RtcHost是核心层控制器结构体，其中的成员在Init函数中会被赋值。
struct RtcHost {
struct IDeviceIoService service;
struct HdfDeviceObject *device;
......@@ -219,11 +230,11 @@ RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动
static int32_t HiRtcBind(struct HdfDeviceObject *device)
{
struct RtcHost *host = NULL;
host = RtcHostCreate(device); // 实际是申请内存并挂接device: host->device = device;
host = RtcHostCreate(device); // 实际是申请内存并挂接device: host->device = device
// 使HdfDeviceObject与RtcHost可以相互转化的前提
...
device->service = &host->service;// 使HdfDeviceObject与RtcHost可以相互转化的前提
// 方便后续通过调用RtcHostFromDevice 实现全局性质的host
// 方便后续通过调用RtcHostFromDevice实现全局性质的host
return HDF_SUCCESS;
}
```
......@@ -252,19 +263,19 @@ RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动
host = RtcHostFromDevice(device);// 这里是HdfDeviceObject到RtcHost的强制转化
rtcInfo = OsalMemCalloc(sizeof(*rtcInfo));
...
// HiRtcConfigData 会从设备配置树中读取属性填充rtcInfo 的supportAnaCtrl, supportLock, spiBaseAddr, regAddrLength, irq
// 为HiRtcSwInit和HiRtcSwInit提供参数，当函数HiRtcSwInit和HiRtcSwInit内部执行失败后进行内存释放等操作
// HiRtcConfigData会从设备配置树中读取属性填充rtcInfo的supportAnaCtrl、supportLock、spiBaseAddr、regAddrLength、irq，
// 为HiRtcSwInit和HiRtcSwInit提供参数，当函数HiRtcSwInit和HiRtcSwInit内部执行失败后进行内存释放等操作。
if (HiRtcConfigData(rtcInfo, device->property) != 0) {
...
}
if (HiRtcSwInit(rtcInfo) != 0) {// 地址映射以及中断注册相关
...
}
if (HiRtcHwInit(rtcInfo) != 0) {// 初始化anaCtrl 和 lockAddr 相关内容
if (HiRtcHwInit(rtcInfo) != 0) {// 初始化anaCtrl和lockAddr相关内容
...
}
host->method = &g_method;//RtcMethod的实例化对象的挂载
host->method = &g_method;// RtcMethod的实例化对象的挂载
host->data = rtcInfo; // 使RtcConfigInfo与RtcHost可以相互转化的前提
HDF_LOGI("Hdf dev service:%s init success!", HdfDeviceGetServiceName(device));
return HDF_SUCCESS;
......@@ -282,7 +293,10 @@ RTC模块适配HDF框架的三个环节是配置属性文件，实例化驱动
函数说明：
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作前提是在Init或Bind函数中具备对应赋值的操作。
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 所有强制转换获取相应对象的操作前提是在Init或Bind函数中具备对应赋值的操作。
```
......
zh-cn/device-dev/driver/driver-platform-sdio-develop.md
浏览文件 @ a88454a6
......@@ -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) **说明：**<br>
> 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) **说明：**<br>
> 实例化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) **说明：**<br>
> 所有强制转换获取相应对象的操作前提是在Bind函数中具备对应赋值的操作。
```
static void Hi35xxLinuxSdioRelease(struct HdfDeviceObject *obj)
......
zh-cn/device-dev/driver/driver-platform-spi-develop.md
浏览文件 @ a88454a6
......@@ -37,23 +37,24 @@ struct SpiCntlrMethod {
## 开发步骤
SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。
SPI模块适配HDF框架的三个必选环节是实例化驱动入口，配置属性文件，以及实例化核心层接口函数。
1. **实例化驱动入口：**
1. 实例化驱动入口
- 实例化HdfDriverEntry结构体成员。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
2. **配置属性文件：**
2. 配置属性文件
- 在device_info.hcs文件中添加deviceNode描述。
- 【可选】添加spi_config.hcs器件属性文件。
3. **实例化SPI控制器对象：**
3. 实例化SPI控制器对象
- 初始化SpiCntlr成员。
- 实例化SpiCntlr成员SpiCntlrMethod。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 实例化SpiCntlr成员SpiCntlrMethod，其定义和成员说明见[接口说明](#接口说明)。
4. **驱动调试：**
4. 驱动调试
【可选】针对新增驱动程序，建议验证驱动基本功能，例如SPI控制状态，中断响应情况等。
......@@ -61,15 +62,20 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
下方将以spi_hi35xx.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释放驱动资源并退出。
SPI驱动入口参考：
SPI驱动入口参考：
```
struct HdfDriverEntry g_hdfSpiDevice = {
.moduleVersion = 1,
.moduleName = "HDF_PLATFORM_SPI",//【必要 且与 HCS文件中里面的moduleName匹配】
.moduleName = "HDF_PLATFORM_SPI",//【必要且与HCS文件中里面的moduleName匹配】
.Bind = HdfSpiDeviceBind, //见Bind参考
.Init = HdfSpiDeviceInit, //见Init参考
.Release = HdfSpiDeviceRelease, //见Release参考
......@@ -78,8 +84,12 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
HDF_INIT(g_hdfSpiDevice);
```
2. 完成驱动入口注册之后，在device_info.hcs文件中添加deviceNode信息，并在 spi_config.hcs中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层SpiCntlr成员的默认值或限制范围有密切关系。
本例只有一个SPI控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在spi_config文件中增加对应的器件属性。
2. 完成驱动入口注册之后，在device_info.hcs文件中添加deviceNode信息，并在spi_config.hcs中配置器件属性。
deviceNode信息与驱动入口注册相关，器件属性值与核心层SpiCntlr成员的默认值或限制范围有密切关系。
本例只有一个SPI控制器，如有多个器件信息，则需要在device_info文件增加deviceNode信息，以及在spi_config文件中增加对应的器件属性。
- device_info.hcs配置参考
......@@ -90,7 +100,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
platform :: host {
hostName = "platform_host";
priority = 50;
device_spi :: device { //为每一个 SPI 控制器配置一个HDF设备节点
device_spi :: device { //为每一个SPI控制器配置一个HDF设备节点
device0 :: deviceNode {
policy = 1;
priority = 60;
......@@ -103,9 +113,9 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
policy = 1;
priority = 60;
permission = 0644;
moduleName = "HDF_PLATFORM_SPI"; // 【必要】用于指定驱动名称，该字段的值必须和驱动入口结构的moduleName值一致
serviceName = "HDF_PLATFORM_SPI_1"; // 【必要且唯一】驱动对外发布服务的名称
deviceMatchAttr = "hisilicon_hi35xx_spi_1"; // 需要与设备hcs文件中的match_attr匹配
moduleName = "HDF_PLATFORM_SPI"; // 【必要】用于指定驱动名称，该字段的值必须和驱动入口结构的moduleName值一致。
serviceName = "HDF_PLATFORM_SPI_1"; // 【必要且唯一】驱动对外发布服务的名称。
deviceMatchAttr = "hisilicon_hi35xx_spi_1"; // 需要与设备hcs文件中的match_attr匹配。
}
...
}
......@@ -114,28 +124,28 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
}
```
- spi_config.hcs 配置参考
- spi_config.hcs配置参考
```
root {
platform {
spi_config {// 每一个SPI控制器配置私有数据
template spi_controller {// 模板公共参数， 继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
spi_config { // 每一个SPI控制器配置私有数据
template spi_controller { // 模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省。
serviceName = "";
match_attr = "";
transferMode = 0; // 数据传输模式：中断传输(0),流控传输(1),DMA传输(2)
busNum = 0; // 总线号
transferMode = 0; // 数据传输模式：中断传输(0)、流控传输(1)、DMA传输(2)
busNum = 0; // 总线号
clkRate = 100000000;
bitsPerWord = 8; // 传输位宽
mode = 19; // SPI 数据的输入输出模式
maxSpeedHz = 0; // 最大时钟频率
minSpeedHz = 0; // 最小时钟频率
speed = 2000000; // 当前消息传输速度
fifoSize = 256; // FIFO大小
numCs = 1; // 片选号
regBase = 0x120c0000; // 地址映射需要
irqNum = 100; // 中断号
bitsPerWord = 8; // 传输位宽
mode = 19; // SPI 数据的输入输出模式
maxSpeedHz = 0; // 最大时钟频率
minSpeedHz = 0; // 最小时钟频率
speed = 2000000; // 当前消息传输速度
fifoSize = 256; // FIFO大小
numCs = 1; // 片选号
regBase = 0x120c0000; // 地址映射需要
irqNum = 100; // 中断号
REG_CRG_SPI = 0x120100e4; // CRG_REG_BASE(0x12010000) + 0x0e4
CRG_SPI_CKEN = 0;
CRG_SPI_RST = 0;
......@@ -144,9 +154,9 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
MISC_CTRL_SPI_CS_SHIFT = 0;
}
controller_0x120c0000 :: spi_controller {
busNum = 0; // 【必要】总线号
CRG_SPI_CKEN = 0x10000; // (0x1 << 16) 0:close clk, 1:open clk
CRG_SPI_RST = 0x1; // (0x1 << 0) 0:cancel reset, 1:reset
busNum = 0; // 【必要】总线号
CRG_SPI_CKEN = 0x10000; // (0x1 << 16) 0:close clk, 1:open clk
CRG_SPI_RST = 0x1; // (0x1 << 0) 0:cancel reset, 1:reset
match_attr = "hisilicon_hi35xx_spi_0";// 【必要】需要和device_info.hcs中的deviceMatchAttr值一致
}
controller_0x120c1000 :: spi_controller {
......@@ -158,16 +168,17 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
irqNum = 101; // 【必要】中断号
}
...
// 【可选】可新增，但需要在device_info.hcs添加对应的节点
// 【可选】可新增，但需要在device_info.hcs添加对应的节点。
}
}
}
```
3. 完成驱动入口注册之后，最后一步就是以核心层SpiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化SpiCntlr成员SpiCntlrMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
3. 完成属性文件配置之后，下一步就是以核心层SpiCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化SpiCntlr成员SpiCntlrMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。
- 自定义结构体参考
从驱动的角度看，自定义结构体是参数和数据的载体，而且spi_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号、总线号等。
从驱动的角度看，自定义结构体是参数和数据的载体，而且spi_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号、总线号等。
```
......@@ -197,7 +208,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
uint8_t transferMode;
};
// SpiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值
// SpiCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值。
struct SpiCntlr {
struct IDeviceIoService service;
struct HdfDeviceObject *device;
......@@ -249,14 +260,14 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
struct SpiCntlr *SpiCntlrCreate(struct HdfDeviceObject *device)
{
struct SpiCntlr *cntlr = NULL; // 创建核心层SpiCntlr对象
struct SpiCntlr *cntlr = NULL; // 创建核心层SpiCntlr对象
...
cntlr = (struct SpiCntlr *)OsalMemCalloc(sizeof(*cntlr));// 分配内存
...
cntlr->device = device; // 使HdfDeviceObject与SpiCntlr可以相互转化的前提
device->service = &(cntlr->service);// 使HdfDeviceObject与SpiCntlr可以相互转化的前提
(void)OsalMutexInit(&cntlr->lock); // 锁初始化
DListHeadInit(&cntlr->list); // 添加对应的节点
cntlr->device = device; // 使HdfDeviceObject与SpiCntlr可以相互转化的前提
device->service = &(cntlr->service); // 使HdfDeviceObject与SpiCntlr可以相互转化的前提
(void)OsalMutexInit(&cntlr->lock); // 锁初始化
DListHeadInit(&cntlr->list); // 添加对应的节点
cntlr->priv = NULL;
return cntlr;
}
......@@ -270,7 +281,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
返回值：
HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。
HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
**表2** HDF_STATUS返回值描述
......@@ -294,10 +305,10 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
int32_t ret;
struct SpiCntlr *cntlr = NULL;
...
cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数。
// return (device == NULL) ? NULL : (struct SpiCntlr *)device->service;
...
ret = Pl022Init(cntlr, device); // 【必要】实例化厂商自定义操作对象，示例见下
ret = Pl022Init(cntlr, device); // 【必要】实例化厂商自定义操作对象，示例见下。
...
ret = Pl022Probe(cntlr->priv);
...
......@@ -311,11 +322,11 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
...
pl022 = (struct Pl022 *)OsalMemCalloc(sizeof(*pl022));// 申请内存
...
ret = SpiGetBaseCfgFromHcs(pl022, device->property); // 初始化busNum, numCs, speed, fifoSize, clkRate,mode, bitsPerWord, transferMode参数值
ret = SpiGetBaseCfgFromHcs(pl022, device->property); // 初始化busNum、numCs、speed、fifoSize、clkRate、mode、bitsPerWord、transferMode参数值。
...
ret = SpiGetRegCfgFromHcs(pl022, device->property); // 初始化regBase, phyBase, irqNum, regCrg, clkEnBit,clkRstBit, regMiscCtrl, regMiscCtrl, miscCtrlCs,miscCtrlCsShift参数值
ret = SpiGetRegCfgFromHcs(pl022, device->property); // 初始化regBase、phyBase、irqNum、regCrg、clkEnBit、clkRstBit、regMiscCtrl、regMiscCtrl、 miscCtrlCs、miscCtrlCsShift参数值。
...
// 计算最大，最小速度对应的频率
// 计算最大、最小速度对应的频率。
pl022->maxSpeedHz = (pl022->clkRate) / ((SCR_MIN + 1) * CPSDVSR_MIN);
pl022->minSpeedHz = (pl022->clkRate) / ((SCR_MAX + 1) * CPSDVSR_MAX);
DListHeadInit(&pl022->deviceList); // 初始化DList链表
......@@ -344,7 +355,10 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
函数说明：
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 所有强制转换获取相应对象的操作前提是在Init函数中具备对应赋值的操作。
```
......@@ -352,8 +366,8 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
{
struct SpiCntlr *cntlr = NULL;
...
cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
// return (device==NULL) ?NULL:(struct SpiCntlr *)device->service;
cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
// return (device==NULL) ?NULL:(struct SpiCntlr *)device->service;
...
if (cntlr->priv != NULL) {
Pl022Remove((struct Pl022 *)cntlr->priv); // 这里有SpiCntlr到Pl022的强制转化
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或