IR Manager (HAL Types and Public API)

Description

Described here in are the IARM-Bus HAL types and functions that are part of the IR Manager application. The IR Manager application manages user input on the IR interface.

Data Structures
struct	PLAT_irKey_metadata
	IR Key struct that maintains meta data. More...

Typedefs
typedef enum PLAT_xmp_tag	PLAT_xmp_tag_t
typedef enum PLAT_xmp_owner	PLAT_xmp_owner_t
typedef struct PLAT_irKey_metadata	PLAT_irKey_metadata_t
	IR Key struct that maintains meta data.
typedef void(*	PLAT_IrKeyCallback_Extended_t) (PLAT_irKey_metadata_t *irKey)
	IR Input key event handler callback function type definition. More...
typedef void(*	PLAT_IrKeyCallback_t) (int keyType, int keyCode)
	IR Input key event handler callback function type definition. More...

Enumerations
enum	PLAT_xmp_tag
enum	PLAT_xmp_owner

Functions
void	PLAT_API_RegisterIRKeyCallbackExtended (PLAT_IrKeyCallback_Extended_t func)
	This API must registers a callback function to which IR Key events should be posted. More...
void	PLAT_API_RegisterIRKeyCallback (PLAT_IrKeyCallback_t func)
	This API must registers a callback function to which IR Key events should be posted. More...
int	PLAT_API_INIT (void)
	This API initializes the underlying IR module. More...
void	PLAT_API_TERM (void)
	This API is used to terminate the IR device module. More...
void	PLAT_API_LOOP ()
	This function executes the key event loop. More...

---

Data Structure Documentation

PLAT_irKey_metadata

struct PLAT_irKey_metadata

IR Key struct that maintains meta data.

Definition at line 65 of file plat_ir.h.

Collaboration diagram for PLAT_irKey_metadata:

Data Fields
int	type	Event type of key press (up, down, repeat, etc)
int	code	Code of the pressed key (left, right, power, etc)
PLAT_xmp_tag_t	tag	Designates which device key belongs.
PLAT_xmp_owner_t	owner	Designates how key should be handled.

Typedef Documentation

PLAT_IrKeyCallback_Extended_t

typedef void(* PLAT_IrKeyCallback_Extended_t) (PLAT_irKey_metadata_t *irKey)

IR Input key event handler callback function type definition.

The Event Data sent contains Key Type, Code, Owner, and Tag of the pressed IR key.

Parameters

[in]

irKey

IR Key struct that contains data on pressed IR Key

Returns

None.

Note

This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Definition at line 84 of file plat_ir.h.

PLAT_IrKeyCallback_t

typedef void(* PLAT_IrKeyCallback_t) (int keyType, int keyCode)

IR Input key event handler callback function type definition.

The Event Data sent contains Key Type and Key Code of the pressed IR key.

Parameters

[in]	keyType	Key Type (e.g. Key Down, Key Up, Key Repeat) of the pressed IR key.
[in]	keyCode	Key Code of the pressed IR key.

Returns

None.

Note

This function must not suspend and must not invoke any blocking system calls. It should probably just send a message to a driver event handler task.

Definition at line 111 of file plat_ir.h.

Function Documentation

PLAT_API_RegisterIRKeyCallbackExtended()

void PLAT_API_RegisterIRKeyCallbackExtended

(

PLAT_IrKeyCallback_Extended_t

func

)

This API must registers a callback function to which IR Key events should be posted.

This function registers the calling applications callback function. The application will then be notified of IR Key events via this callback function.

Parameters

[in]

func

Function reference of the callback function to be registered.

Returns

None.

PLAT_API_RegisterIRKeyCallback()

void PLAT_API_RegisterIRKeyCallback

(

PLAT_IrKeyCallback_t

func

)

This API must registers a callback function to which IR Key events should be posted.

This function registers the calling applications callback function. The application will then be notified of IR Key events via this callback function.

Parameters

[in]

func

Function reference of the callback function to be registered.

Returns

None.

PLAT_API_INIT()

int PLAT_API_INIT

(

void

)

This API initializes the underlying IR module.

This function must initialize all the IR specific user input device modules.

Returns

The status of the operation.

Return values

Returns

O if successful, appropriate error code otherwise

PLAT_API_TERM()

void PLAT_API_TERM

(

void

)

This API is used to terminate the IR device module.

This function must terminate all the IR specific user input device modules. It must reset any data structures used within IR module and release any IR specific handles and resources.

PLAT_API_LOOP()

void PLAT_API_LOOP

(

)

This function executes the key event loop.

This function executes the platform-specific key event loop. This will generally translate between platform-specific key codes and Comcast standard keycode definitions.