Fujitsu DTV/STB solution driver (FAPex driver) Documentation [V01L00R00]


fapex/abst_libir.h File Reference

abstraction library header file (IR driver) More...

Data Structures

struct  FAPEX_IR_OpenParamStrT
 open parameters for the IR driver More...
struct  FAPEX_IR_KeyParamStrT
 key parameters for the IR driver More...
struct  FAPEX_IR_KeycodeMapStrT
 Struct of the mapping table. More...
struct  FAPEX_IR_MapTableParamStrT
 map table parameters for the IR driver More...
struct  FAPEX_IR_StatusStrT
 status for the IR driver More...

Defines

#define FAPEX_IR_ERR_BASE   (FAPEX_IR_MODULE_BASE + FAPEX_RET_ERR_BASE)
#define FAPEX_IR_ERR_BAD_PARAMETER   (FAPEX_IR_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)
#define FAPEX_IR_ERR_OUT_OF_MEMORY   (FAPEX_IR_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)
#define FAPEX_IR_ERR_TIMEOUT   (FAPEX_IR_ERR_BASE + FAPEX_ERR_TIMEOUT)
#define FAPEX_IR_ERR_INVALID_STATUS   (FAPEX_IR_ERR_BASE + FAPEX_ERR_INVALID_HANDLE)
#define FAPEX_IR_KEY_UNDEFINED   0x0000
#define FAPEX_IR_KEY_BACK   0x0008
#define FAPEX_IR_KEY_TAB   0x0009
#define FAPEX_IR_KEY_OK   0x000D
#define FAPEX_IR_KEY_0   0x0030
#define FAPEX_IR_KEY_1   0x0031
#define FAPEX_IR_KEY_2   0x0032
#define FAPEX_IR_KEY_3   0x0033
#define FAPEX_IR_KEY_4   0x0034
#define FAPEX_IR_KEY_5   0x0035
#define FAPEX_IR_KEY_6   0x0036
#define FAPEX_IR_KEY_7   0x0037
#define FAPEX_IR_KEY_8   0x0038
#define FAPEX_IR_KEY_9   0x0039
#define FAPEX_IR_KEY_STANDBY   0x0080
#define FAPEX_IR_KEY_EXIT   0x0081
#define FAPEX_IR_KEY_TEXT   0x0082
#define FAPEX_IR_KEY_APPL   0x0083
#define FAPEX_IR_KEY_MENU   0x0084
#define FAPEX_IR_KEY_HIDE   0x0085
#define FAPEX_IR_KEY_NAVI   0x0086
#define FAPEX_IR_KEY_TV   0x0087
#define FAPEX_IR_KEY_CHANNEL_UP   0x0088
#define FAPEX_IR_KEY_CHANNEL_DOWN   0x0089
#define FAPEX_IR_KEY_INFO   0x008A
#define FAPEX_IR_KEY_VCR   0x008B
#define FAPEX_IR_KEY_MUTE   0x008C
#define FAPEX_IR_KEY_VOL_UP   0x008D
#define FAPEX_IR_KEY_VOL_DOWN   0x008E
#define FAPEX_IR_KEY_RIGHT   0x0090
#define FAPEX_IR_KEY_LEFT   0x0091
#define FAPEX_IR_KEY_UP   0x0092
#define FAPEX_IR_KEY_DOWN   0x0093
#define FAPEX_IR_KEY_PLAY   0x0094
#define FAPEX_IR_KEY_REC   0x0095
#define FAPEX_IR_KEY_STOP   0x0096
#define FAPEX_IR_KEY_PAUSE   0x0097
#define FAPEX_IR_KEY_REWIND   0x0098
#define FAPEX_IR_KEY_FORWARD   0x0099
#define FAPEX_IR_KEY_FORWSLOW   0x009E
#define FAPEX_IR_KEY_REWSLOW   0x009F
#define FAPEX_IR_KEY_RED   0x009A
#define FAPEX_IR_KEY_GREEN   0x009B
#define FAPEX_IR_KEY_YELLOW   0x009C
#define FAPEX_IR_KEY_BLUE   0x009D
#define FAPEX_IR_KEY_PIPSELECT   0x00A0
#define FAPEX_IR_KEY_F1   0x00A1
#define FAPEX_IR_KEY_F2   0x00A2
#define FAPEX_IR_KEY_F3   0x00A3
#define FAPEX_IR_KEY_F4   0x00A4
#define FAPEX_IR_KEY_PIPSWAP   0x00A5
#define FAPEX_IR_MODE_NONE   0
 no protocol mode
#define FAPEX_IR_MODE_RC5   1
 RC5 protocol mode.
#define FAPEX_IR_MODE_NEC   2
 NEC protocol mode.
#define FAPEX_IOCCOM_IR_OPEN   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 0, FAPEX_IR_OpenParamStrT)
 ioctl specific command for the IR driver
#define FAPEX_IOCCOM_IR_GET_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 1, FAPEX_IR_StatusStrT)
#define FAPEX_IOCCOM_IR_GET_KEY   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 2, FAPEX_IR_KeyParamStrT)
#define FAPEX_IOCCOM_IR_SET_MAPTABLE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 3, FAPEX_IR_MapTableParamStrT)
#define FAPEX_IOCCOM_IR_REMOVE_MAPTABLE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 4, int32_t)

Functions

FAPEXOPENRET_T FAPEX_IR_Open (FAPEXOPENARG1_T id, FAPEXOPENARG2_T flags, FAPEXOPENARG3_T argptr)
 open method. This function is called with the systemcall "open".
FAPEXRELRET_T FAPEX_IR_Close (FAPEXRELARG1_T id)
 release method. This function is called with the systemcall "close".
FAPEXREADRET_T FAPEX_IR_Read (FAPEXREADARG1_T id, FAPEXREADARG2_T buf, FAPEXREADARG3_T count)
 read method. This function is called with the systemcall "read".
This function is waited for until the key event is generated.
FAPEXIOCRET_T FAPEX_IR_Ioctl (FAPEXIOCARG1_T id, FAPEXIOCARG2_T cmd, FAPEXIOCARG3_T pArg)
 ioctl method. This function is called with the systemcall "ioctl".

Detailed Description

abstraction library header file (IR driver)

Attention:
This program is provided as is. You can redistribute it and/or modify it. Fujitsu Semiconductor Limited accepts no responsibility or liability for any errors or omissions.

Copyright (C) 2008-2010 Fujitsu Semiconductor Limited, All Rights Reserved.


Define Documentation

#define FAPEX_IR_ERR_BASE   (FAPEX_IR_MODULE_BASE + FAPEX_RET_ERR_BASE)

Standard error codes for the driver

FAPex IR error code base value

#define FAPEX_IR_ERR_BAD_PARAMETER   (FAPEX_IR_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)

Bad parameter passed.

#define FAPEX_IR_ERR_OUT_OF_MEMORY   (FAPEX_IR_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)

Memory allocation failed.

#define FAPEX_IR_ERR_TIMEOUT   (FAPEX_IR_ERR_BASE + FAPEX_ERR_TIMEOUT)

Timeout occured.

#define FAPEX_IR_ERR_INVALID_STATUS   (FAPEX_IR_ERR_BASE + FAPEX_ERR_INVALID_HANDLE)

Invalid status.

#define FAPEX_IR_KEY_UNDEFINED   0x0000
#define FAPEX_IR_KEY_BACK   0x0008
#define FAPEX_IR_KEY_TAB   0x0009
#define FAPEX_IR_KEY_OK   0x000D
#define FAPEX_IR_KEY_0   0x0030
#define FAPEX_IR_KEY_1   0x0031
#define FAPEX_IR_KEY_2   0x0032
#define FAPEX_IR_KEY_3   0x0033
#define FAPEX_IR_KEY_4   0x0034
#define FAPEX_IR_KEY_5   0x0035
#define FAPEX_IR_KEY_6   0x0036
#define FAPEX_IR_KEY_7   0x0037
#define FAPEX_IR_KEY_8   0x0038
#define FAPEX_IR_KEY_9   0x0039
#define FAPEX_IR_KEY_STANDBY   0x0080
#define FAPEX_IR_KEY_EXIT   0x0081
#define FAPEX_IR_KEY_TEXT   0x0082
#define FAPEX_IR_KEY_APPL   0x0083
#define FAPEX_IR_KEY_MENU   0x0084
#define FAPEX_IR_KEY_HIDE   0x0085
#define FAPEX_IR_KEY_NAVI   0x0086
#define FAPEX_IR_KEY_TV   0x0087
#define FAPEX_IR_KEY_CHANNEL_UP   0x0088
#define FAPEX_IR_KEY_CHANNEL_DOWN   0x0089
#define FAPEX_IR_KEY_INFO   0x008A
#define FAPEX_IR_KEY_VCR   0x008B
#define FAPEX_IR_KEY_MUTE   0x008C
#define FAPEX_IR_KEY_VOL_UP   0x008D
#define FAPEX_IR_KEY_VOL_DOWN   0x008E
#define FAPEX_IR_KEY_RIGHT   0x0090
#define FAPEX_IR_KEY_LEFT   0x0091
#define FAPEX_IR_KEY_UP   0x0092
#define FAPEX_IR_KEY_DOWN   0x0093
#define FAPEX_IR_KEY_PLAY   0x0094
#define FAPEX_IR_KEY_REC   0x0095
#define FAPEX_IR_KEY_STOP   0x0096
#define FAPEX_IR_KEY_PAUSE   0x0097
#define FAPEX_IR_KEY_REWIND   0x0098
#define FAPEX_IR_KEY_FORWARD   0x0099
#define FAPEX_IR_KEY_FORWSLOW   0x009E
#define FAPEX_IR_KEY_REWSLOW   0x009F
#define FAPEX_IR_KEY_RED   0x009A
#define FAPEX_IR_KEY_GREEN   0x009B
#define FAPEX_IR_KEY_YELLOW   0x009C
#define FAPEX_IR_KEY_BLUE   0x009D
#define FAPEX_IR_KEY_PIPSELECT   0x00A0
#define FAPEX_IR_KEY_F1   0x00A1
#define FAPEX_IR_KEY_F2   0x00A2
#define FAPEX_IR_KEY_F3   0x00A3
#define FAPEX_IR_KEY_F4   0x00A4
#define FAPEX_IR_KEY_PIPSWAP   0x00A5
#define FAPEX_IR_MODE_NONE   0

no protocol mode

#define FAPEX_IR_MODE_RC5   1

RC5 protocol mode.

#define FAPEX_IR_MODE_NEC   2

NEC protocol mode.

#define FAPEX_IOCCOM_IR_OPEN   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 0, FAPEX_IR_OpenParamStrT)

ioctl specific command for the IR driver

#define FAPEX_IOCCOM_IR_GET_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 1, FAPEX_IR_StatusStrT)
#define FAPEX_IOCCOM_IR_GET_KEY   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 2, FAPEX_IR_KeyParamStrT)
#define FAPEX_IOCCOM_IR_SET_MAPTABLE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 3, FAPEX_IR_MapTableParamStrT)
#define FAPEX_IOCCOM_IR_REMOVE_MAPTABLE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_IR + 4, int32_t)

Function Documentation

FAPEXOPENRET_T FAPEX_IR_Open ( FAPEXOPENARG1_T  id,
FAPEXOPENARG2_T  flags,
FAPEXOPENARG3_T  argptr 
)

open method. This function is called with the systemcall "open".

Parameters:
idThe device identifier.
flagsThis parameter indicate a open mode (read only/write only/read-write).
This implementation supports only read-write mode.
argptrargument pointer (FAPEX_IR_OpenParamStrT)
If descriptor for this 'id' has already been opened, this 'argptr' will be invalid.
Return values:
>=0process OK, new file descriptor is returned.
<0process fails, its value is set to errno.
FAPEXRELRET_T FAPEX_IR_Close ( FAPEXRELARG1_T  id )

release method. This function is called with the systemcall "close".

Parameters:
idThe identifier for this descriptor.
Return values:
0process OK
<0process fails, its value is set to errno.
FAPEXREADRET_T FAPEX_IR_Read ( FAPEXREADARG1_T  id,
FAPEXREADARG2_T  buf,
FAPEXREADARG3_T  count 
)

read method. This function is called with the systemcall "read".
This function is waited for until the key event is generated.

Parameters:
idThe identifier for this descriptor.
bufThe pointer to the destination buffer which is in the user space.
countThe data size.
Return values:
>=0process OK, its value is the number of bytes actually read.
<0process fails, its value is set to errno.
FAPEXIOCRET_T FAPEX_IR_Ioctl ( FAPEXIOCARG1_T  id,
FAPEXIOCARG2_T  cmd,
FAPEXIOCARG3_T  pArg 
)

ioctl method. This function is called with the systemcall "ioctl".

Parameters:
idThe identifier for this descriptor.
cmdThe ioctl command.
pArgThe pointer to the argument of the ioctl command.
Return values:
0process OK
<0process fails, its value is set to errno.

ioctl command(cmd) type:



Copyright © 2006-2010 by Fujitsu Semiconductor Europe GmbH
Copyright © 2008-2010 by Fujitsu Semiconductor Limited

Disclaimer:
Please note that the use of this has been based on the terms and conditions of "DK Consent Letter (For Linux)" agreement between you and Fujitsu Semiconductor Limited.
The contents of this document may be revised without prior notice. Contact our sales department for confirmation. The information in this document are presented as is, no license is granted by implication or otherwise.
More...

FUJITSU sales representatives