source: svn/trunk/newcon3bcm2_21bu/dta/src/settop_api/bsettop_user_io.h

/***************************************************************************
 *     Copyright (c) 2003-2006, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * $brcm_Workfile:  $
 * $brcm_Revision:  $
 * $brcm_Date: $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log:  $
 *
 ***************************************************************************/
 
#ifndef BSETTOP_USER_IO_H__
#define BSETTOP_USER_IO_H__

#include "bsettop_types.h"


#ifdef __cplusplus
extern "C"
{
#endif

/*=*********************
Control user input and output, including:

o LED's, including 7-segment LED's
o Remote controls
o Front panel
o IR keyboards

The key codes are passed through unmodified in a 32-bit structure.
***********************/

/* User Input API */

/*
Summary:
        Open a user input object for receiving IR remote and keypad input.
Description:
        For now, the following id's are used:
        0 - remote a
        1 - remote b
        2 - 56 MHz Sejin IR Keyboard
        3 - keypad
*/
buser_input_t buser_input_open(
                     bobject_t user_input_id /* user input object id */
                    );

/*
Summary:
        Close a user input handle.
Description:
        Releases all resources associated with the user input object
*/
void buser_input_close(
        buser_input_t ui /* user input object */
    );

/*
Summary:
Representation of a user event.
Description:
The actual protocol for each input device is different. But they all
fit into the same storage space.
*/
typedef struct buser_input_event {
    uint32_t code;              /* One event is always contained in 32 bits of information */
} buser_input_event;


/*
Summary:
Read events from a user input device.

Description:
Because this function does not return a void* to raw data, but an array of structures,
it is not called buser_input_read.
*/
bresult buser_input_get_event(
        buser_input_t ui, /* user input object */
        buser_input_event *event, /* [out,size_is(nevents)] event from the user */
        unsigned nevents, /* number of entries in the event array */
        unsigned *result_nevents /* [out] number of entries read */
        );
/*
Summary:
Maps physical input code to the internal code used in the higher level software.  
Returns 0xFF for invalid code or the internal system key codes.  See bapp.h
*/
unsigned int buser_input_map_code(
                                                                unsigned int code /* input code */
                                                                );

void buser_input_sim_key(uint32_t code);


typedef enum button_t
{
    eButton_000 = 0x000,
    eButton_00P= 0x001,
    eButton_0U0= 0x010,
    eButton_0UP= 0x011,
    eButton_D00= 0x100,
    eButton_D0P= 0x101,
    eButton_DU0= 0x110,
    eButton_DUP= 0x111,
}button_t;

int AOV_buser_input_GetButtonfactory(void);
void aov_Set_Button_CHUpDown(unsigned int  keyIn);

#ifdef __cplusplus
}
#endif


#endif /* BSETTOP_USER_IO_H__ */