/** @file DLIB_SDDS.h @brief Type defines used for SDDS (software download data service) */ #ifndef __DLIB_SDDS_H__ #define __DLIB_SDDS_H__ #include "DHL_Types.h" //#include "DLIB_BitOp.h" #ifdef __cplusplus extern "C" { #endif #if COMMENT ____Overview____(){} #endif #if COMMENT ____Config____(){} #endif #define SUPPORT_SDDS_DST_EXTENSION 1 #if COMMENT ____Types_Base____(){} #endif #define SDDS_Table_ID_Msg 0x3B #define SDDS_Table_ID_Data 0x3C #define SDDS_Message_ID_DSI 0x1006 #define SDDS_Message_ID_DII 0x1002 #define SDDS_Message_ID_DDB 0x1003 #define SDDS_Message_ID_DC 0x1005 typedef struct { UINT8 protocolDiscriminator; UINT8 dsmccType; UINT16 messageId; UINT32 transactionId; UINT8 adaptationLength; UINT16 messageLength; //dsmccAdaptationHeaderPtr_t adaptationHeader; } sddsMessageHeader_t; typedef struct { UINT8 table_id; UINT8 section_syntax_indicator; UINT16 table_id_extension; UINT8 version_number; // not used. always 0 UINT8 current_next_indicator; // not used. always 1 UINT8 section_number; UINT8 last_section_number; } sddsSectionHeader_t; #if COMMENT ____Compat_Desc____(){} #endif /** 아래 둘 이외의 값은 예약.. */ typedef enum { eSystemHardwareDescriptor = 0x01, eSystemSoftwareDescriptor = 0x02, } compatDescriptorType; /** sdds에서 현재 지원하는 타입은 IEEE OUI 한 종류 뿐이다. */ #define compatSpecifierType_IEEE_OUI 0x01 /* 디지털스트림테크놀로지 OUI */ #define IEEE_OUI_DST 0x001E1B /** DST에서 정의한 디스크립터. 공장에서 sdds가 실행되는 경우, 해당 스트림에 이 디스크립터가 존재해야 한다. 방송국에서 송출하는 sdds 스트림에는 이 디스크립터가 없어야 한다. tag 와 한바이트 데이터만으로 구성된 아주 간단한 디스크립터 이다. length=1. TAG (8 bit), LENGTH (8 bit), DATA (8 bit) */ #define compatSubDescFactoryLocationTag 0xF7 #define compatSubDescFactoryLocationData 0x3E typedef struct { UINT8 subDescriptorType; // 이 subdescriptor 의 타입. 타입 값은 specifier가 알아서 정함. UINT8 subDescriptorLength; // 아래 additional Information의 바이트 길이. UINT8 *additionalInformation; // specifier(제조사)가 임의로 사용 할 수 있는 영역. } sddsCompatSubDesc_t; typedef struct { UINT8 descriptorType; // one of compatDescriptorType // sdds 에서는 system HW, system SW 두가지만 지원한다. //UINT8 descriptorLength; // descriptorType, descriptorLength (자신)을 제외한 바이트 크기. // parsing 된 이후에는 별 의미 없으므로 제거. UINT8 specifierType; // should be compatSpecifierType_IEEE_OUI UINT32 specifierData; // actually this is 24 bits OUI. UINT16 model; UINT16 version; // 아래 정보는 제조사 마음대로 사용할 수 있는 부분이다. // 일단 필요 할 것으로 보이므로 parsing을 해 놓아야 한다. // UINT8 subDescriptorCount; // 아래 subDescriptors 갯수. sddsCompatSubDesc_t *subDescriptors; // subDescriptor array. } sddsCompatDescEntry_t; typedef struct { //UINT16 descriptorLength; // 이 compat descriptor 의 전체 바이트 크기. (자신은 제외) // parsing 된 후에는 이 정보는 별 의미 없으므로 삭제. UINT16 descriptorCount; // 아래 desc 갯수. // sdds 규격에 의해 최대 2개만 지원한다. 최대값:2 sddsCompatDescEntry_t desc[2]; // 최대 2개 만 지원하므로 2로 제한. // sdds 규격에 의하면 desc[0]은 HW 정보, desc[1]은 SW 정보이다. } sddsCompatDesc_t; #if COMMENT ____Types_Desc____(){} #endif /** @name SDDS descriptor types @{ */ #define SDDS_module_info_tag 0xB7 #define SDDS_schedule_tag 0xBA // 아래는 SDDS는 아니지만, A/90 에서 정의된 descriptor 들이다. #define A90_module_link_tag 0xB4 #define A90_CRC32_tag 0xB5 #define A90_group_link_tag 0xB8 #define A90_download_tag 0xA6 #define A90_multiprotocol_encapsulation_tag 0xA7 #define A90_data_service_tag 0xA4 #define A90_PID_count_tag 0xA5 #define A90_association_tag 0x14 #if SUPPORT_SDDS_DST_EXTENSION // 100809, module info desc의 private data 부분을 descriptors list로 구성함. // 현재는 아래 descriptor 하나만 존재. #define SDDS_DST_module_info_tag 0xC0 #endif /** @} */ #define ModuleType_BootLoader 0x01 #define ModuleType_Application 0x08 #if SUPPORT_SDDS_DST_EXTENSION /* 이 모듈(firmware)의 타입 및 동작 가능한 Hardware 보드 버전 리스트를 나열한다. 이 타입의 필드들은 모두 UINT8 타입이므로, 임의 포인터에 casting 해서 사용 가능하다. */ typedef struct { // descriptor tag: SDDS_DST_module_info_tag (0xc0) // 펌웨어 타입. // one of ModuleType_XXXX above.. UINT8 moduleType; UINT8 moduleName[16+1]; // parser에서 null-term 추가 함. UINT8 moduleVer[8+1]; // parser에서 null-term 추가 함. // 이 펌웨어가 동작 가능한 하드웨어 버전 (리비전) 리스트. UINT8 numSupportedHwVersions; UINT8 *supportedHwVersions; // 한 프로젝트에서 보드 20개 정도면 충분할 듯.. // // HW 버전 할당은 보통 나온 순서대로 명령을 한다. // 보통은 00 prototype, 01:ES 02:DS 03:PP 04:MP 순서가 된다. // 파생 모델이 많은데 (예: tuner dual vendor, flash size variation..) // 모델 분기를 하지 않고 HW 버전 만으로 서로 공유할 수 있다. UINT32 fileCRC32; } sddsDstModuleInfoDesc_t; #endif // SUPPORT_SDDS_DST_EXTENSION /** 모듈 정보 디스크립터 sdds에서는 DII의 moduleInfoLength 다음의 디스크립터 리스트에 포함된다. 모듈 상세 정보를 표현할 수 있다. */ typedef struct { // tag: SDDS_module_info_tag 0xB7 UINT8 encoding; UINT8 nameLength; UINT8 *nameBytes; // UTF-8 format. // parser에서는 null-terminate될 수 있도록 추가 공간 확보해 둔다. UINT8 signatureType; UINT8 signatureLength; UINT8 *signatureBytes; // parser에서는 null-terminate될 수 있도록 추가 공간 확보해 둔다. UINT8 privateModuleLength; UINT8 *privateModuleBytes; #if SUPPORT_SDDS_DST_EXTENSION // dst 제품에서는 privateModuleBytes 는 각 firmware의 상세 정보인데, // sddsDstModuleInfoDesc_t 타입을 활용한다. // privateModule 정보 중에서 아래 정보는 별도로 추출해 놓도록 한다. // 참고로 이 안의 포인터는 malloc 된 것은 아니고 privateModuleBytes 내의 위치 포인터임. // 어차피 memChain으로 관리할 것이므로 함부로 free 하지만 않는다면 문제되지는 않음. // sddsDstModuleInfoDesc_t dstinfo; #endif } sddsModuleInfoDesc_t; /** 스케줄 디스크립터 */ typedef struct { UINT32 startTime; // 다운로드 가능한 window 시작 시간. UINT32 lengthInSeconds; // 20 bit 길이다. 최대 표현 가능 시간은 ~291 hour = ~12 days } sddsScheduleEntry_t; typedef struct { // tag: SDDS_schedule_tag 0xBA // 스케줄 정보는 하나 이상을 전달 할 수 있음. UINT8 numSchedules; sddsScheduleEntry_t *schedules; } sddsScheduleDesc_t; #if COMMENT ____Types_DSI____(){} #endif /** dsi 메시지의 groupInfoIndication 에 해당되는 부분 */ typedef struct { UINT32 groupId; // 이 id는 dii 메시지의 transactionId와 일치한다. UINT32 groupSize; // 이 그룹에 속하는 모든 모듈들의 크기 총 합. sddsCompatDesc_t compat; // 이 그룹의 compatibility. // sdds 규격에 의하면 최소한 한개의 compat 정보를 포함해야 한다. UINT16 groupInfoLength; UINT8 *groupDescriptors; // 이 그룹에 해당되는 정보를 전달하는데, // sdds에서는 여기에 schedule descriptor가 전달 된다. sddsScheduleDesc_t scheduleDescriptor; // 특별히 schedule descriptor에 한정하여, 따로 parsing을 해 놓는다. // 일반 다른 descriptor는 필요한 경우에 한하여 client가 parsing. // schedule descriptor가 존재하지 않는 경우는 내부의 numSchedule 이 0이다.. } sddsDsiGroup_t; /** download server initiate */ typedef struct { BOOL section_syntax_indicator; // TRUE if CRC32 used, FALSE if checksum used. UINT32 transactionId; //UINT16 messageLength; // client will not want this info // server id 부터 crc 직전까지의 길이. //UINT8 serverId[20]; // fixed value. don't keep here. // 항상 고정된 0xff 패턴을 가지므로, 저장할 필요가 없다. 삭제. sddsCompatDesc_t compat; // A/91 규격에 의하면 dsi의 top-level compat은 없다고 함. // compat.descriptorCount 가 0일 것임. // UINT16 privateDataLength; // 아래 group info indication 정보의 바이트 길이를 의미. // checksum 직 전까지의 길이다. // 파싱 된 이후에는 의미 없으므로 삭제함. UINT16 numberOfGroups; // 아래 groups 배열의 요소 갯수. sddsDsiGroup_t *groups; // group 배열 포인터. UINT16 groupInfoPrivateDataLength; // 아래 groupInfoPrivateDataBytes의 길이. UINT8 *groupInfoPrivateDataBytes; UINT32 checksum_CRC32; } sddsDsi_t, *sddsDsiPtr_t; #if COMMENT ____Types_DII____(){} #endif typedef struct { UINT16 moduleId; // 0x0000 부터 0xFFEF 사이의 unique id 값. UINT32 moduleSize; // 모듈의 바이트 단위 크기. // 이 모듈에 속하는 모든 DDB 메시지의 payload 합이다. (헤더, crc 등의 정보 제외) // 0이면 모듈 크기가 미리 정해지지 않았다는 의미이며, streaming에 사용된다. UINT8 moduleVersion; // 실제 파일의 버전 정보를 표시하기에는 충분치 않으므로 사용하지 않는다. UINT8 moduleInfoLength; // 아래 descriptor list의 바이트 크기. UINT8 *moduleDescriptors; // A/91에 따르면 moduleId가 0x0000~0xFFEF 인 경우에는 // 다음 디스크립터들이 올 수 있다. // module_link_desc, CRC32_desc, .. // A/97 에서는 추가로 sddsModuleInfoDesc_t 를 정의하고 있다. sddsModuleInfoDesc_t *moduleInfoDesc; // 편의를 위해서 위의 moduleDescriptors 중에서 // moduleInfoDescriptor 하나의 정보를 parsing 해서 별도의 포인터로 준비해 놓는다. // // !!!! 주의 !!!! // 이 포인터 역시 sddsDiiModule_t의 memChain에 연결되어 있다. // 함부로 pointer를 떼어서 가져가거나 free 시키면 안된다. } sddsDiiModule_t; /** download info indication */ typedef struct { /* table ID is 0x3B fixed. do not keep here. */ BOOL section_syntax_indicator; // TRUE if CRC32 used, FALSE if checksum used. UINT32 transactionId; // dsi 메시지의 groupId와 일치한다. //UINT16 messageLength; // 파싱 된 이후에는 이 정보는 별로 필요 없다. 삭제. UINT32 downloadId; // == carousel_id UINT16 blockSize; // typical value: 4066 sddsCompatDesc_t compat; // A/91 에서는 이 descriptor는 사용하지 않는다고 한다. UINT16 numberOfModules; sddsDiiModule_t *modules; UINT16 privateDataLength; UINT8 *privateDataBytes; // 사용자 private data. UINT32 checksum_CRC32; } sddsDii_t, *sddsDiiPtr_t; #if COMMENT ____Types_DDB____(){} #endif /** 주의 사항. DDB는 section size가 거의 최대 크기인데 (~4096) 이 payload를 위한 메모리 malloc은 하지 않고, parser는 그냥 psi section buffer 내의 포인터만 keep해 놓는다. client는 parsing 후에 tDHL_PSI_DataArray를 Free 하기 전에 필요한 정보를 처리 해야 한다. */ /** data download block */ typedef struct { /* table ID is 0x3B fixed. do not keep here. */ BOOL section_syntax_indicator; // TRUE if CRC32 used, FALSE if checksum used. // table_id_extension // 섹션 헤더의 table_id_extension은 일반적인 경우와 다르게, downloadId가 아닌, moduleId 값을 갖는다. // 섹션 헤더의 version은 moduleVersion의 LSB 5 비트 값을 갖는다. // 섹션 헤더의 section_number는 blockNumber의 하위 1바이트 이다. // 이 값들은 다른 필드로부터 추출이 가능하므로 별도로 keep 하지는 않는다. // version_number // moduleVersion 의 하위 5비트와 값이 동일하다. // section_number // section_number는 blockNumber의 LSB 8-bits와 동일하다. UINT32 downloadId; // sdds의 경우 carousel id 와 동일하다. //UINT8 adaptationLength; // PTS가 포함된 데이터 블럭이 규격 상 가능한가?? // 일단 고려하지 않는다. // 하지만 parser는 adaptionLength가 있을 경우 적절하게 skip하도록 해야 함. //UINT16 messageLength; // 파싱 된 이후에는 이 정보는 별로 필요 없다. 삭제. UINT16 moduleId; // 이 블럭이 속한 모듈 id. UINT8 moduleVersion; UINT16 blockNumber; // 0 부터 시작하는 block index. UINT8 *blockDataBytePtr; // 이 포인터는 malloc으로 할당 받은 것이 아님. UINT16 blockDataLength; // 이 값은 messageLength 값으로부터 계산 된 값이다. UINT32 checksum_CRC32; } sddsDdb_t, *sddsDdbPtr_t; #ifdef __cplusplus } /* extern "C" */ #endif #endif /* __DLIB_SDDS_H__ */