FVID函数说明
FVID的一些函数说明
FVID 函数：
FVID_create()作用：是分配并初始化FVID通道对象;
语法:fvidChan = FVID_create (name, mode, *status, optArgs, *attrs);
参数定义：
String name /* handle to an instance of the device */
Int mode /* pointer to buffer allocated by driver */
Int *status /* pointer to size of buffer pointed to by */
Ptr optArgs /* */
FVID_Attrs *attrs /* */
其中:
name是设备实例的句柄,是一个字符串mode 是选择的模式,只有两个值:IOM_INPUT 设置采集模式,IOM_OUTPUT设置显示模式。
status是由下层mini driver返回的状态值。
attrs 是指向FVID_Attrs结构的指针:
FVID_Attrs的定义如下:
typedef struct FVID_Attrs {
Uns timeout;
} FVID_Attrs;
timeout成员用来指定旗语同步,它的值可以是:
SYS_FOREVER:会让FVID_alloc, FVID_free and FVID_exchange的调用不确定的等待到这个调用完成.
数字的timeout值会让这些APIs阻塞一段指定的时间(以系统时钟). 0值会让APIs不阻塞,他们会立刻返回,这种情况下,应用程序会检查返回的status值来保证调用已经成功完成.
备注:FVID_alloc, FVID_free 和 FVID_exchange 的调用只能在 DSP/BIOS task (TSK).
FVID_create的返回值:
如果通道成功的打开了,那么FVID_create返回一个指向通道的句柄.这个句柄可以用来让后来的模块调用这个通道.
实列：
/* Initialize the attributes */
FVID_ATTRS dispAttrs = FVID_ATTRS;
/* Create an instance to a video display device */ chan-
Handle = FVID_create(“\display0”, IOM_INPUT, NULL, NULL,&dispAttrs);
FVID_control()作用是:发送一个控制命令给下层的mini_driver
语法: status = FVID_control (fvidChan, cmd, args);
参数定义:
FVID_Handle fvidChan /* handle to an instance of the device */
Int cmd /* control command */
Ptr args /* pointer to control command arguments */
Return Value Int status /* returns IOM_COMPLETED if successful */
参数说明:
fvidChan 是FVID_create()创建的指向通道的句柄。
cmd有两个值:IOM_ABORT----作用是中止所以的未定的I/O工作。
IOM_FLUSH----作用是所以采集口的工作被丢弃,所以显示I/O的工作正常进行。
Args 是要传递的命令(参数或者结构体)的指针。
返回值:如果调用成功,FVID_control返回IOM_COMPLETED .如果有错误产生,这个调用会返回一个负值。
实例：
/* abort all pending video driver I/O jobs */
FVID_control(fvidChan, IOM_ABORT, NULL);
FVID-alloc()作用：申请获得驱动程序缓存单元。
语法：status = FVID_alloc (fvidChan, bufp);
参数定义：
FVID_Handle fvidChan /* handle to an instan
ce of the device */
Ptr bufp /* pointer to buffer allocated by driver */
Return Value Int status /* returns IOM_COMPLETED if successful */
参数说明：
fvidChan 是FVID_create()创建的指向通道的句柄。
bufp 是输出参数，指向所申请的驱动缓存空间的指针。
返回值：如果调用成功,FVID_alloc()返回IOM_COMPLETED，如果有错误产生,这个调用会返回一个负值。
备注：这个函数只能是在外设已经加载和初始化之后才能调用。其中的句柄应该由FVID_create()函数提供。
实例：
/* allocate a buffer from the device */
status = FVID_alloc(chanHandle, dispBuf);
FVID_exchange()作用：交换应用程序和驱动程序缓存空间，实际作用相当于FVID_free()和FVID_alloc()函数的组合。
语法： status = FVID_exchange (fvidChan, bufp);
参数定义：
FVID_Handle fvidChan /* handle to an instance of the device */
Ptr bufp /* pointer to buffer exchanged by driver */
LgUns *pSize /* pointer to size of buffer pointed to by bufp */
参数说明：
fvidChan 是FVID_create()创建的指向通道的句柄。
bufp 是输入输出参数，刚开始指向的是应用程序需要交换的缓存空间，交换后，指向与驱动程序进行缓存空间交换后的内存空间。
pSize 是指向bufp内存大小的指针。
返回值：如果调用成功,FVID_exchange()返回IOM_COMPLETED，如果有错误产生,这个调用会返回一个负值。
备注：这个函数只能是在外设已经加载和初始化之后才能调用。其中的句柄应该由FVID_create()函数提供。
实例：
/* allocate a buffer from the device */
status = FVID_exchange(chanHandle, dispBuf);
FVID_free()作用：释放返回应用程序申请的缓存给驱动程序
语法： status = FVID_free (fvidChan, bufp);
参数定义：
FVID_Handle fvidChan /* handle to an instance of the device */
Ptr bufp /* pointer to buffer to be relinquished to driver */
LgUns *pSize /* pointer to size of buffer pointed to by bufp */
参数说明：
fvidChan 是FVID_create()创建的指向通道的句柄。
bufp 是输入参数，指向的是应用程序需要释放返回的缓存空间。
pSize 是指向bufp内存大小的指针。
返回值：如果调用成功,FVID_free()返回IOM_COMPLETED，如果有错误产生,这个调用会返回一个负值。
备注：这个函数只能是在外设已经加载和初始化之后才能调用。其中的句柄应该由FVID_create()函数提供。
实例：
Example /* free a buffer back to the device */
status = FVID_free(chanHandle, dispBuf);
FVID_delete()作用： 申请关闭一个FVID channel 对象。
语法： status = FVID_delete (fvidChan);
参数定义：
FVID_Handle fvidChan /* handle to an instan
ce of the device */
参说说明：
fvidChan 是FVID_create()创建的指向通道的句柄。
返回值：如果调用成功,FVID_delete()返回IOM_COMPLETED，如果有错误产生,这个调用会返回一个负值。
备注：这个函数只能是在外设已经加载和初始化之后才能调用。其中的句柄应该由FVID_create()函数提供。
实例：
Example /* allocate a buffer from the device */
status = FVID_delete(chanHandle);