plat_ir.h File Reference

IR HAL header. More...

Go to the source code of this file.

Data Structures
struct	PLAT_irKey_metadata
	IR Key struct to store the IR key meta data. More...

Typedefs
typedef enum PLAT_xmp_tag	PLAT_xmp_tag_t
	xmp tag type. This is used to specify the different remote types
typedef enum PLAT_xmp_owner	PLAT_xmp_owner_t
	xmp owner type describes whether key received in pairing or normal mode
typedef struct PLAT_irKey_metadata	PLAT_irKey_metadata_t
	IR Key struct to store the IR key meta data.
typedef void(*	PLAT_IrKeyCallback_Extended_t) (PLAT_irKey_metadata_t *irKey)
	HAL must call this function when an extended IR key is received.
typedef void(*	PLAT_IrKeyCallback_t) (int keyType, int keyCode)
	HAL must call this function when an IR key is received.

Enumerations
enum	PLAT_xmp_tag {   XMP_TAG_COMCAST = 0x00 , XMP_TAG_PLATCO = 0x01 , XMP_TAG_XR11V2 = 0x02 , XMP_TAG_XR15V1 = 0x03 ,   XMP_TAG_XR15V2 = 0x04 , XMP_TAG_XR16V1 = 0x05 , XMP_TAG_XRAV1 = 0x06 , XMP_TAG_XR20V1 = 0x07 ,   XMP_TAG_PLATCOV2 = 0x08 , XMP_TAG_UNDEFINED }
	xmp tag type. This is used to specify the different remote types More...
enum	PLAT_xmp_owner { XMP_OWNER_NORMAL = 0x00 , XMP_OWNER_PAIRING = 0x01 , XMP_OWNER_UNDEFINED }
	xmp owner type describes whether key received in pairing or normal mode More...

Functions
void	PLAT_API_RegisterIRKeyCallbackExtended (PLAT_IrKeyCallback_Extended_t func)
	This function is used to register for Extended IR key events.
void	PLAT_API_RegisterIRKeyCallback (PLAT_IrKeyCallback_t func)
	This function is used to register for IR key events.
int	PLAT_API_INIT (void)
	This API initializes the underlying IR module.
void	PLAT_API_TERM (void)
	This API is used to terminate the IR device module.
void	PLAT_API_LOOP ()
	This function executes the key event loop.

Detailed Description

IR HAL header.

This file defines APIs, datatypes and error codes used by the IR HAL.

Document

Document reference.

Open Issues (in no particular order)

1. None

Assumptions

1. None

Abbreviations

• IR: Infra red
• XMP: IR protocol. Platform specific
• HAL: Hardware abstraction layer
• XR Remote type

Implementation Notes

1. None