Forráskód Böngészése

doc: Fix developer guide typo

https://github.com/rockchip-linux/mpp/discussions/785
Reported by: Huangli95

Signed-off-by: Herman Chen <herman.chen@rock-chips.com>
Change-Id: I825b56477299854eedfe9dbe38e93f9769b9800d
Herman Chen 2 hónapja
szülő
commit
52e8ae7ac1

+ 1 - 1
doc/Rockchip_Developer_Guide_MPP_CN.md

@@ -280,7 +280,7 @@ MppApi结构体封装了MPP的对外API接口,用户通过使用MppApi结构
 | dequeue           | 函数指针 | MPP_RET (\*dequeue)(MppCtx ctx, MppPortType type, MppTask \*task) <br/>端口出队列接口,用于从端口中取出MppTask结构。 <br/>ctx :MPP实例上下文。 <br/>type :端口类型,分为输入端口与输出端口。 <br/>task :MppTask。 <br/>返回值 :0为正常,有数据可取出,非零为错误码。 |
 | enqueue           | 函数指针 | MPP_RET (\*enqueue)(MppCtx ctx, MppPortType type, MppTask task) <br/>端口入队列接口,用于往端口送入MppTask结构。 <br/>ctx :MPP实例上下文。 <br/>type :端口类型,分为输入端口与输出端口。 <br/>task :MppTask。 <br/>返回值 :0为正常,有数据可取出,非零为错误码。 |
 | reset             | 函数指针 | MPP_RET (\*reset)(MppCtx ctx) <br/>复位接口,用于对MppCtx的内部状态进行复位,回到可用的初始化状态。需要注意的是,reset接口是阻塞的同步接口。 <br/>ctx :MPP实例上下文。 <br/>返回值 :0为正常,有数据可取出,非零为错误码。 |
-| control           | 函数指针 | MPP_RET (\*control)(MppCtx ctx, MpiCmd cmd, MppParam param) <br/>控制接口,用于向MPP实例进行额外控制操作的接口。 <br/>ctx :MPP实例上下文。 <br/>cmd :Mpi命令类型,表示控制命令的不同类型的。 <br/>task :Mpi命令参数,表示控制控制命令的附加参数。 <br/>返回值 :0为正常,有数据可取出,非零为错误码。 |
+| control           | 函数指针 | MPP_RET (\*control)(MppCtx ctx, MpiCmd cmd, MppParam param) <br/>控制接口,用于向MPP实例进行额外控制操作的接口。 <br/>ctx :MPP实例上下文。 <br/>cmd :Mpi命令类型,表示控制命令的不同类型的。 <br/>param :Mpi命令参数,表示控制控制命令的附加参数。 <br/>返回值 :0为正常,有数据可取出,非零为错误码。 |
 
 # 第三章 MPI接口使用说明
 

+ 2 - 2
doc/Rockchip_Developer_Guide_MPP_EN.md

@@ -267,7 +267,7 @@ The MppApi structure encapsulates the API of MPP. User implements the video code
 | dequeue            | Function pointer | MPP_RET (\*dequeue)(MppCtx ctx, MppPortType type, MppTask \*task) The port dequeue interface is used to dequeue the MppTask structure from the port. <br>ctx :MPP instance context. <br>type :Port types are divided into input port and output port. <br>task :MppTask<br>return value :0 is normal, non-zero is error code.                                                                                                                                            |
 | enqueue            | Function pointer | MPP_RET (\*enqueue)( MppCtx ctx, MppPortType type, MppTask task) The port enqueue interface is used to feed the port into the MppTask structure. <br>ctx :MPP instance context. <br>type :Port types are divided into input port and output port. <br>task :MppTask<br>return value:0 is normal, non-zero is error code.                                                                                                                                                |
 | reset              | Function pointer | MPP_RET (\*reset)(MppCtx ctx) The reset interface is used to reset the internal state of MppCtx and set to available initialized state. <br>NOTE: the reset interface is a blocked synchronous interface. <br>ctx :MPP instance context. <br>return value :0 is normal, non-zero is error code.                                                                                                                                                                           |
-| control            | Function pointer | MPP_RET (\*control)(MppCtx ctx, MpiCmd cmd, MppParam param) Control interface, an interface for additional control operations to MPP instances. <br>ctx :MPP instance context. <br>cmd :Mpi command id, representing different types of control commands. <br>task :The Mpi command parameter represents the additional parameter of the control command. <br>return value :0 is normal, non-zero is error code.                                                            |
+| control            | Function pointer | MPP_RET (\*control)(MppCtx ctx, MpiCmd cmd, MppParam param) Control interface, an interface for additional control operations to MPP instances. <br>ctx :MPP instance context. <br>cmd :Mpi command id, representing different types of control commands. <br>param :The Mpi command parameter represents the additional parameter of the control command. <br>return value :0 is normal, non-zero is error code.                                                            |
 
 # Chapter 3 MPI interface instructions
 
@@ -1077,4 +1077,4 @@ A: No problem, mpp has some dependencies on the kernel driver, the kernel driver
 
 Q: How to analyze the problem of abnormal MPP operation?
 
-A: First analyze the error log. If there is a log that fails to open the kernel device, you need to analyze whether the hardware device configuration file of the video codec of the kernel platform is available, and then submit the problem to redmine. After analyzing the operating environment problem, analyze the MPP operation Internal issue.
+A: First analyze the error log. If there is a log that fails to open the kernel device, you need to analyze whether the hardware device configuration file of the video codec of the kernel platform is available, and then submit the problem to redmine. After analyzing the operating environment problem, analyze the MPP operation Internal issue.