/** @file DHL_UIO.h @brief User I/O module API header Copyright 2006~2010 Digital STREAM Technology, Inc. All Rights Reserved */ #ifndef __DHL_UIO_API_H__ #define __DHL_UIO_API_H__ #include "DHL_OSAL.h" #ifdef __cplusplus extern "C" { #endif #if COMMENT ____Overview____(){} #endif /** @file DHL_UIO.h module overview - 다음과 같은 사용자 입출력 기능을 제공한다. - IR 리모컨 입력 - 전면 베젤 등의 버튼 입력 - LED, 7-세그먼트, VFD 등의 출력 - 별도의 MICOM이 따로 제공되는 경우와, SoC에서 직접 처리하는 경우에 따라 내부 동작은 많이 달라지겠지만 API 인터페이스 구성에서는 구분하지 않는다. - 모든 입력 데이터는 단일 루틴에서 처리된다. (tDHL_UIO_InputCb) - UIO API 설계에 대한 상세한 내용은 "DHL UIO API Design" 문서를 참고한다. - dependencies - 플랫폼 구성에 따라 달라질 수 있겠지만 DHL_UART 모듈과, DHL_SYS 의 GPIO 부분을 사용한다. - 하지만 이 모듈들의 public API를 사용하는 것이 아니고 내부 함수를 사용하여 연결되므로 이 UIO API 상으로 dependency는 보이지 않는다. */ #if COMMENT ____Config____(){} #endif /* 헤더 파일에 포함되어야 할 global config은 아직까지는 없음. 만약 있다면 별도의 설정 파일에 추가하도록 하자. #include "DHL_Config.h" */ #if COMMENT ____Types____(){} #endif /** @brief UIO 모듈에서 처리하는 모든 데이터 타입. 입력 전용, 출력 전용으로 나누어져 있음. */ typedef enum { eDHL_UIO_INPUT_NONE = -1, /*------- input */ eDHL_UIO_INPUT_MIN = 0, eDHL_UIO_INPUT_IR = eDHL_UIO_INPUT_MIN, eDHL_UIO_INPUT_KEYPAD, eDHL_UIO_INPUT_GPIO, eDHL_UIO_INPUT_MICOM, eDHL_UIO_INPUT_MAX, /*------- output */ eDHL_UIO_OUTPUT_MIN = 8, eDHL_UIO_OUTPUT_LED = eDHL_UIO_OUTPUT_MIN, eDHL_UIO_OUTPUT_7SEG, eDHL_UIO_OUTPUT_VFD, eDHL_UIO_OUTPUT_MAX, } tDHL_UIO_Type; #ifdef __DEFINE_UIO_STRINGS__ const char *DHL_UIO_TypeName(tDHL_UIO_Type s) { return ( (s)==eDHL_UIO_INPUT_IR ? "ir" : \ (s)==eDHL_UIO_INPUT_KEYPAD ? "kpd" : \ (s)==eDHL_UIO_INPUT_GPIO ? "gpb" : \ (s)==eDHL_UIO_INPUT_MICOM ? "mic" : \ (s)==eDHL_UIO_OUTPUT_LED ? "led" : \ (s)==eDHL_UIO_OUTPUT_7SEG ? "seg" : \ (s)==eDHL_UIO_OUTPUT_VFD ? "vfd" : \ "??" ); } #else const char *DHL_UIO_TypeName(tDHL_UIO_Type source); #endif /** @brief UIO 키 입력 Note! IR 입력에 대해서는 raw data to UIO Code 변환을 client 에서 처리한다. DHL 레벨에서는 그냥 전체 데이터를 되돌려 준다. */ typedef enum { eDHL_KEY_NONE, eDHL_KEY_POWER, eDHL_KEY_UP, eDHL_KEY_DOWN, eDHL_KEY_LEFT, eDHL_KEY_RIGHT, eDHL_KEY_SELECT, eDHL_KEY_BACK, eDHL_KEY_MENU, eDHL_KEY_EXIT, eDHL_KEY_SOURCE, eDHL_KEY_INFO, eDHL_KEY_GUIDE, eDHL_KEY_HELP, eDHL_KEY_FUNCTION, eDHL_KEY_DISPLAY, eDHL_KEY_SCREEN, eDHL_KEY_RESOLUTION, eDHL_KEY_VIDEO, eDHL_KEY_ASPECT, eDHL_KEY_AUDIO, eDHL_KEY_SOUND, eDHL_KEY_CAPTION, eDHL_KEY_SIGNAL, eDHL_KEY_VOL_UP, eDHL_KEY_VOL_DOWN, eDHL_KEY_CH_UP, eDHL_KEY_CH_DOWN, eDHL_KEY_0, eDHL_KEY_1, eDHL_KEY_2, eDHL_KEY_3, eDHL_KEY_4, eDHL_KEY_5, eDHL_KEY_6, eDHL_KEY_7, eDHL_KEY_8, eDHL_KEY_9, eDHL_KEY_RESET, } tDHL_UIO_Key; /** @brief UIO 입력의 각종 세부 동작을 설정할 때 사용되는 설정 타입. DHL_UIO_Config() API 에서 사용된다. DHL_UIO_Config() API에서 또다른 인자인 void *param 과 같이 사용된다. 아래 각 type 별로 어떤 추가 파라미터가 필요한지 명시 되어야 한다. */ typedef enum { /** ----------------------------------- 파라미터: BOOL bEnablePassThrough; uio 처리기를 bypass 시킬 것인지 여부를 설정한다. TRUE 이면 feeding 된 데이터는 그대로 client에게 bypass 된다. bypass를 하면 DHL 내부의 GPIO 버튼 반복 기능 등은 제공되지 않는다. client 에서 모든 세부 처리를 수행하고자 할 때 사용한다. */ eDHL_UIO_Cfg_PassThrough, /** ----------------------------------- 파라미터: BOOL bUseReleaseEvent; not yet.. */ eDHL_UIO_Cfg_UseReleaseEvent, /** ----------------------------------- 파라미터: tDHL_UIO_InputDataFilter *filter IR 입력 데이터에 대해서 pre-filtering을 수행한다. 주로 특정 vendor code를 걸러 내기 위해서 설정한다. 이것을 설정하지 않으면 모든 입력이 uio filter를 통과하여 client에 전달된다. client 에서 vendor code filtering을 해도 되지만, uio 처리 루틴 이전에 하는 것이 더 효율적이다. */ eDHL_UIO_Cfg_InputDataFilter, /** ----------------------------------- 파라미터: tDHL_UIO_DebounceTiming *timing GPIO 버튼 입력과, KeyPad 버튼 입력에 대해서 debounce timing을 설정한다. 아직 완성되지 않았음. 일단 driver/hal 내부의 디폴트 설정 대로 동작한다. customer에 따라 다른 debounce 설정이 필요하다면 그 때 구현하자. */ eDHL_UIO_Cfg_Debounce, /** ----------------------------------- 파라미터: tDHL_UIO_RepeatSetting *repeat IR, GPIO 버튼, KeyPad 버튼 등에 대해서 반복 기능을 설정한다. all zero를 설정하여 반복 기능 자체를 disable 할 수도 있다. 디폴트 값은 상세 타이밍은 소스 코드 내에 fix되어 있다. 이 설정은 어떤 종류의 키가 입력되었는지에 상관 없이 일률적으로 적용되는 global 설정이다. 각 키 별로 repeat 적용 여부를 다르게 한다던가, repeat timing을 다르게 적용하고 싶다면 아래 eDHL_UIO_Cfg_CheckRepeatCb 을 사용해야 한다. */ eDHL_UIO_Cfg_RepeatSetting, /** ----------------------------------- 파라미터: tDHL_UIO_CheckRepeatCb callback repeat 여부를 입력되는 각 키 별로 다르게 적용하고자 하는 경우 사용한다. 여기서 callback을 등록해 놓으면, 모든 키 입력이 있을 때 마다 지정한 callback이 호출되며, 그 때 마다 입력 키에 따른 각각 repeat 설정을 해 주면 된다. 주의: 파라미터 callback은 함수 포인터이다. 파라미터에 NULL을 지정할 수 있다. 그럴 경우 데이터 별 반복 설정은 하지 않고 global 설정 (위 eDHL_UIO_Cfg_RepeatSetting 으로 설정한 값)에 따른다. */ eDHL_UIO_Cfg_CheckRepeatCb, } tDHL_UIO_ConfigType; /** @brief UIO input data filter 구조체. IR 입력 데이터의 pre-filtering을 하기 위한 필터 정보이다. 주로 IR code 중에서 vendor code 걸러내기 위한 용도로 사용된다. 즉 IR 입력 데이터 중에서 특정 vendor code 만 처리하고자 할 때, 특정 정보만 pass하도록 이 필터를 작성한 후, DHL_Config(eDHL_UIO_Cfg_InputDataFilter, filter) 와 같이 호출하면 된다. 범용 filter 구조를 채택한 이유는 지원하게 될 IR 방식이 여러가지가 될 수 있기 때문. 참고로 NEC IR 방식의 경우 IR data는 4바이트이다. */ #define DHL_UIO_MAX_INPUT_FILTER 10 typedef struct { int numFilter; struct { UINT32 mask; UINT32 data; } filters[DHL_UIO_MAX_INPUT_FILTER]; /* filter pass 알고리즘 'numFilter' 갯수에 해당되는 모든 filter 체크. 입력 데이터를 'mask'로 masking 하여 'data'와 비교. 어느 하나라도 match가 되면 pass. 하나도 match가 안되면 throw out. */ } tDHL_UIO_InputDataFilter; /** @brief 각종 반복 설정 시 사용하는 타입. tDHL_UIO_CheckRepeatCb 타입의 인자로 사용된다. 반복 예: msIntervalFirst = 600 msIntervalNext = 200 모두 millisecond 단위이다. */ typedef struct { UINT32 msIntervalFirst; ///< 최초 지연 시간 UINT32 msIntervalNext; ///< 두번째 부터의 지연 시간 } tDHL_UIO_RepeatSetting; /** @brief 데이터 별 키 반복 설정 여부 및 설정 타이밍을 query하는 콜백. source, data: [IN] DHL 에서 설정해서 콜백을 호출함. settings: [OUT] client가 callback 내에서 값을 설정한 후 리턴. settings 내의 값이 모두 0인 경우, 해당 data에 대해서 반복 기능을 사용하지 않음을 의미한다. */ typedef void (*tDHL_UIO_CheckRepeatCb)(tDHL_UIO_Type source, UINT32 data, tDHL_UIO_RepeatSetting *settings); /** @brief UIO callback 에서 사용 될 flag 타입. 아래 \#define flag 들의 조합이다. */ typedef UINT32 tDHL_UIO_Flag; #define DHL_UIO_FLAG_Released 0x01 // 버튼 류 에서만 사용. set 이면 release 되었음을 의미. //#define DHL_UIO_FLAG_Pressed 0x02 // 버튼류의 경우, set 이면 pressed, non-set 이면 released. #define DHL_UIO_FLAG_IsRepeat 0x80 // set 이면 HW repeat 상태임. 이 flag는 Pressed의 의미를 내포하고 있음. /** @brief 처리 되고 난 후의 최종 데이터가 전달 되는 콜백. DHL_UIO_RegisterCallback API를 이용하여 등록된다. */ typedef void (*tDHL_UIO_InputCb)(tDHL_UIO_Type source, UINT32 data, tDHL_UIO_Flag flag); /** @brief Generic Purpose UIO output control. */ typedef enum { /**----------------------------- Low-level control */ eDHL_UIO_CT_LowLevelMin = 0x100, /** LED 각각을 on/off control. 한 번에 하나의 led 만 control 가능하다. id : 는 led 각각을 구분하는 index. 0 부터 시작하는 enum 값. param: 0 또는 1 */ eDHL_UIO_CT_LED = 0x100, eDHL_UIO_CT_7SEG, eDHL_UIO_CT_VFD, /**----------------------------- High-level control */ eDHL_UIO_CT_HighLevelMin = 0x1000, /** 간단한 (1~2 bits wide) 상태 표시기 LED가 될 수도 있고, 7Segment의 특정 bit led, 또는 VFD 내의 특정 영역 on/off 가 될 수 있음. 어떠한 Output type 인지는 구분하지 않는다. MICOM을 통하여 제어되는 경우에는 내부에서 UART command를 보내야 될 수도 있음. id : tDHL_UIO_IndicatorType param: 각 indicator type 별로 정의된 데이터. */ eDHL_UIO_CT_Indicator, } tDHL_UIO_ControlType; /** @brief eDHL_UIO_CT_Indicator 의 부가 데이터 타입. */ typedef enum { eDHL_UIO_IT_Power, // power state (0:off, 1:stby, 2:full) eDHL_UIO_IT_Status0, // generic purpose status eDHL_UIO_IT_Status1, eDHL_UIO_IT_Status2, eDHL_UIO_IT_Status3, eDHL_UIO_IT_IR, // ir input detect eDHL_UIO_IT_Network, // network connection alive } tDHL_UIO_IndicatorType; #if COMMENT ____Defines____(){} #endif #define DHL_UIO_IsInput(t) ((t)>=eDHL_UIO_INPUT_MIN && (t)=eDHL_UIO_OUTPUT_MIN && (t) 문제 있음.. Segment via micom: boot, play.., goodbye control(micom_msg, msg_id) vfd via micom */ /** @brief UIO 입력에 공통적으로 사용되는 callback 등록. 입력 데이터 종류에 상관 없이 모든 입력 데이터는 이 callback을 통해 전달된다. DHL_UIO_Config 설정에 따라 내부에서 가공 처리가 될 수도 있다. @param[in] cb 등록 할 콜백 함수. */ void DHL_UIO_RegisterCallback(tDHL_UIO_InputCb cb); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* __DHL_UIO_API_H__ */