/** @file DHL_SYS.h @brief System Control APIs Copyright 2006~2010 Digital STREAM Technology, Inc. All Rights Reserved */ #ifndef __DHL_SYS_API_H__ #define __DHL_SYS_API_H__ #include "DHL_OSAL.h" #ifdef __cplusplus extern "C" { #endif #if COMMENT ____Overview____(){} #endif /** @file DHL_SYS.h module overview APIs implementations dependencies */ #if COMMENT ____Config____(){} #endif /** GPIO 번호 등은 platform 마다 달라질 수 있는 내용이므로, 별도의 파일로 관리한다. */ #include "DHL_SYS_Config.h" #if COMMENT ____Types____(){} #endif enum DHL_HOST_ENDIAN { eENDIAN_UNKNOWN = 0, eENDIAN_BIG, eENDIAN_LITTLE }; typedef enum { eDHL_SYS_CB_MIN = 0, eDHL_SYS_CB_SWITCH = 100, /* define your own switch info in Impl.. */ eDHL_SYS_CB_BUTTON = 200, /* define your own button info in Impl.. */ eDHL_SYS_CB_CUSTOM = 300, /* define your own info in Impl.. */ eDHL_SYS_CB_MAX = 400, } DHL_SYS_CB_TYPE; /** @brief HAL에서 지원하는 보드 타입. revision 정보로 구분이 안되는 보드들은 아래에 서로 구분된 type으로 추가 필요하다. runtime 시에 체크가 안되는 보드 타입은 DHL_CONFIG.h 에서 DHL_CFG_BOARDTYPE_XXX 으로 build time 확정 되어야 함. */ typedef enum { eDHL_BOARD_UNKNOWN, ///< /*==== Broadcom STB SoC base (bcm7xxx) ==== */ eDHL_BOARD_CRUX, eDHL_BOARD_DCAS, eDHL_BOARD_NEO, eDHL_BOARD_TRINITY, eDHL_BOARD_UDCP, eDHL_BOARD_HOTIP, /*==== Renesas EMMA3 SL/P based ==== */ /** NEC는 Renesas로 변경되었으므로 EMMA라는 이름을 사용하자. 또한 Eval 보드는 Tube3 Proto, ES1, ES2 등 다양하며, Proto는 FE가 착탈식이라서 타입의 의미가 반감된다. 일단 하나의 Type으로 통일한다. 나중에라도 SubType을 구분하고 싶다면 추가하기 바람. */ eDHL_BOARD_EMMA3EVAL = 0x10, ///< Renesas EMMA3 SL/P Board eDHL_BOARD_NEWBY = 0x20, eDHL_BOARD_NEWCON, eDHL_BOARD_NEWCON2, eDHL_BOARD_NEWCON3 } DHL_BOARD_TYPE; /** @brief 각 보드 타입 내에서 관리하는 보드 리비전. DHL_SYS_GetBoardTypeVersion() API에서 리턴되는 값이다. 일반적으로 보드 리비전을 관리하는 방법은 GPIO의 HWBIT을 이용하는데, 각 HWBIT 값의 의미는 보드 타입 별로 달라질 수 있다. 예를 들어 NEO 보드는 네 비트를 사용하는데 0010b 이 R0.2 를 의미하지만, 향후 나올 새 프로젝트에서는 세 비트만 사용하고 010b가 0.3이 될 수도 있을 것임. enum 값에 대응하는 실제 값으로는 16-bit 값을 사용한다. */ typedef enum { eREV_None = 0, eREV_010 = 0x0010, eREV_015 = 0x0015, eREV_020 = 0x0020, eREV_021 = 0x0021, eREV_025 = 0x0025, eREV_030 = 0x0030, eREV_035 = 0x0035, eREV_040 = 0x0040, eREV_045 = 0x0045, eREV_050 = 0x0050, eREV_055 = 0x0055, eREV_060 = 0x0060, eREV_065 = 0x0065, eREV_070 = 0x0070, eREV_075 = 0x0075, eREV_080 = 0x0080, eREV_085 = 0x0085, eREV_090 = 0x0090, eREV_095 = 0x0095, eREV_100 = 0x0100, } DHL_BOARD_REV; /** @brief 전원 모드 DHL_SYS_Reset API의 인자로 사용된다. */ typedef enum { eDHL_RESET_Standby, ///< 저전력 상태. CPU 외 일부 회로만 ON. eDHL_RESET_Normal, ///< full powered mode eDHL_RESET_Reboot, ///< 재부팅. } DHL_RESET_MODE; /** @brief 시스템 일반 제어 타입. DHL_SYS_Control API의 인자로 사용된다. 각 타입 별로 param 인자의 type 및 의미가 정의된다. */ typedef enum { /** system reset 하는 일은 별도의 API인 DHL_SYS_Reset API와 동일하다. param: DHL_RESET_MODE */ eSYSCTL_Reset, /** */ //eSYSCTL_Watchdog, } DHL_SYSCTL_TYPE; /** @breif 시스템 일반 query 타입. DHL_SYS_Query API의 인자로 사용된다. 각 query 타입 별로 pdata 인자의 타입/의미가 정의된다. */ typedef enum { /** get ddr clock frequency in MHz. pdata: UINT32 * */ eSYSQRY_DDRClock, } DHL_SYSQRY_TYPE; #if COMMENT ____Defines____(){} #endif #if COMMENT ____GPIO____(){} #endif /** @name GPIO APIs @{ */ /** @brief GPIO direction mode TriState output 지원하지 않는 system의 경우 그냥 output 으로 동작하도록 함. */ typedef enum { eDHL_GPIO_MODE_Input, eDHL_GPIO_MODE_Output, eDHL_GPIO_MODE_OutputZ, ///< Tristate output. hard wired AND logic. eDHL_GPIO_MODE_Max, } DHL_GPIO_MODE; /** @brief GPIO 인터럽트 모드 */ typedef enum { eDHL_GPIO_INT_Disabled, /*! No interrupt */ eDHL_GPIO_INT_RisingEdge, /*! Interrupt on a 0->1 transition */ eDHL_GPIO_INT_FallingEdge, /*! Interrupt on a 1->0 transition */ eDHL_GPIO_INT_Edge, /*! Interrupt on both a 0->1 and a 1->0 transition */ eDHL_GPIO_INT_Low, /*! Interrupt on a 0 value */ eDHL_GPIO_INT_High, /*! Interrupt on a 1 value */ eDHL_GPIO_INT_Max } DHL_GPIO_INT_MODE; /** @brief 사용자 GPIO ISR 콜백 함수 prototype. DHL_SYS_EnableGpioInt 에서 사용. */ typedef void (*DHL_GPIO_CALLBACK)(int gpio_num, UINT32 user_param); /** @file DHL_SYS.h @todo 아래 함수는 API로 제공될 필요가 없으므로 제거. 이 기능은 init 할 때 내부적으로 수행되어야 한다. DHL_RESULT DHL_SYS_GpioConfig(void); */ /** @file DHL_SYS.h @todo 아래 API는 사용하는 곳이 없으므로 제거. // reset all GPIO pins that configured as a "RESET".. # define DHL_SYS_GpioResetAll(void) (DHL_OK) */ #if SUPPORT_MICOM /** @brief GPIO 방향 설정 API @param[in] gpio GPIO 번호. 숫자 대신 상수 값을 사용할 것. @param[in] eMode 적용 할 GPIO 동작 모드. @param[in] value output 모드인 경우 설정 할 상태 값. @return */ //DHL_RESULT DHL_SYS_SetGpioDirection(int gpio, DHL_GPIO_MODE eMode, BOOL value); #endif /** @brief 특정 GPIO에 인터럽트를 설정. @param[in] gpio GPIO 번호. 숫자 대신 상수 값을 사용할 것. @param[in] eIntMode 설정 할 인터럽트 모드. @param[in] cb 인터럽트 발생 시 호출 될 사용자 콜백 함수. @param[in] param 콜백 호출 시 전달 될 사용자 파라미터. @return */ //DHL_RESULT DHL_SYS_EnableGpioInt(int gpio, DHL_GPIO_INT_MODE eIntMode, DHL_GPIO_CALLBACK cb, UINT32 param); /** @file DHL_SYS.h @todo 아래 함수는 사용하지 않으므로 삭제. //void DHL_SYS_InstallGpioISR(DHL_GPIO_CALLBACK cb); */ /*@}*/ //DHL_RESULT DHL_SYS_GpioConfig(void); // reset all GPIO pins that configured as a "RESET".. #define DHL_SYS_GpioResetAll(void) (DHL_OK) /* following APIs are deprecated now. will be re-visited in future. */ #define DHL_SYS_GpioName(gpio) ("ERR") #define DHL_SYS_GpioNum(gpio) (gpio) #define DHL_SYS_GpioPad(gpio) (0) /* gpio read/write routines. */ /** @brief GPIO set API @param[in] gpio GPIO 번호. 숫자 대신 상수 값을 사용할 것. */ #define DHL_SYS_SetGPIO(gpio) dhl_sys_gpio_rw((gpio), 1, TRUE) /** @brief GPIO reset API @param[in] gpio GPIO 번호. 숫자 대신 상수 값을 사용할 것. */ #define DHL_SYS_ResetGPIO(gpio) dhl_sys_gpio_rw((gpio), 0, TRUE) /** @brief GPIO status read API @param[in] gpio GPIO 번호. 숫자 대신 상수 값을 사용할 것. */ #define DHL_SYS_ReadGPIO(gpio) dhl_sys_gpio_rw((gpio), 0, FALSE) /* GPIO control routines. usually, this api is not needed. only DHL_SYS_Impl use it. */ #define DHL_SYS_SetGpioDirection(gpio, bOutput) \ dhl_sys_gpio_config((gpio), (bOutput) ? DHL_GPIO_OUTPUT : DHL_GPIO_INPUT) #define DHL_SYS_InstallGpioISR(gpio, routine) (DHL_FAIL_NOT_IMPLEMENTED) #define DHL_SYS_EnableGpioInt(gpio, bEnable) (DHL_FAIL_NOT_IMPLEMENTED) #if COMMENT ____API____(){} #endif /** @brief 보드의 타입 및 리비전 정보. @param[out] pType 보드 타입 @param[out] pVer 보드 리비전 정보. */ DHL_RESULT DHL_SYS_GetBoardTypeVersion(DHL_BOARD_TYPE *pType, DHL_BOARD_REV *pVer); /** @brief 보드의 power 상태 설정. - 저전력 상태 진입 (스탠바이 모드) - 일반 상태로 깨어남 - 일반 상태에서 리부팅 @param[in] mode 전환 할 보드 전원 상태. */ DHL_RESULT DHL_SYS_Reset(DHL_RESET_MODE mode); /** @brief 시스템의 각종 제어 @param[in] type 제어 타입. @param[in] param type 별 추가 파라미터. */ DHL_RESULT DHL_SYS_Control(DHL_SYSCTL_TYPE type, UINT32 param); /** @brief 시스템 각종 상태 query @param[in] type query할 데이터 종류. @param[out] pdata query 된 결과가 전달될 포인터. 실제 타입은 type에 따라 달라짐. */ DHL_RESULT DHL_SYS_Query(DHL_SYSQRY_TYPE type, void *pdata); #if COMMENT ____Watchdog____(){} #endif BOOL DHL_SYS_IsWatchdogEnabled(void); void DHL_SYS_EnableWatchdog(void); void DHL_SYS_DisableWatchdog(void); #if COMMENT ____Init____(){} #endif /** @brief SYS 모듈 초기화. GPIO 등 SYS 모듈 내 기능 초기화. */ DHL_RESULT DHL_SYS_Init(void); /** @brief SYS 모듈 shutdown */ DHL_RESULT DHL_SYS_Uninit(void); #if COMMENT ____PlatformInit____(){} #endif /** @brief 플랫폼 메인 초기화 함수. 각 플랫폼 별로 초기화 하는 순서 등이 다를 수 있으므로, 메인 초기화 함수 자체를 platform 에서 제공하는 형식으로 하자. SYS 초기화, OSAL 초기화, Dbg Module 초기화 등 모든 HAL 초기화 순서를 이 함수 안에서 결정해서 진행한다. */ void DHL_SYS_PlatformInit(void); /** @brief 플랫폼 메인 셧다운 함수. */ void DHL_SYS_PlatformUninit(void); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* __DHL_SYS_API_H__ */