1 //<MStar Software> 2 //****************************************************************************** 3 // MStar Software 4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved. 5 // All software, firmware and related documentation herein ("MStar Software") are 6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by 7 // law, including, but not limited to, copyright law and international treaties. 8 // Any use, modification, reproduction, retransmission, or republication of all 9 // or part of MStar Software is expressly prohibited, unless prior written 10 // permission has been granted by MStar. 11 // 12 // By accessing, browsing and/or using MStar Software, you acknowledge that you 13 // have read, understood, and agree, to be bound by below terms ("Terms") and to 14 // comply with all applicable laws and regulations: 15 // 16 // 1. MStar shall retain any and all right, ownership and interest to MStar 17 // Software and any modification/derivatives thereof. 18 // No right, ownership, or interest to MStar Software and any 19 // modification/derivatives thereof is transferred to you under Terms. 20 // 21 // 2. You understand that MStar Software might include, incorporate or be 22 // supplied together with third party`s software and the use of MStar 23 // Software may require additional licenses from third parties. 24 // Therefore, you hereby agree it is your sole responsibility to separately 25 // obtain any and all third party right and license necessary for your use of 26 // such third party`s software. 27 // 28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as 29 // MStar`s confidential information and you agree to keep MStar`s 30 // confidential information in strictest confidence and not disclose to any 31 // third party. 32 // 33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any 34 // kind. Any warranties are hereby expressly disclaimed by MStar, including 35 // without limitation, any warranties of merchantability, non-infringement of 36 // intellectual property rights, fitness for a particular purpose, error free 37 // and in conformity with any international standard. You agree to waive any 38 // claim against MStar for any loss, damage, cost or expense that you may 39 // incur related to your use of MStar Software. 40 // In no event shall MStar be liable for any direct, indirect, incidental or 41 // consequential damages, including without limitation, lost of profit or 42 // revenues, lost or damage of data, and unauthorized system use. 43 // You agree that this Section 4 shall still apply without being affected 44 // even if MStar Software has been modified by MStar in accordance with your 45 // request or instruction for your use, except otherwise agreed by both 46 // parties in writing. 47 // 48 // 5. If requested, MStar may from time to time provide technical supports or 49 // services in relation with MStar Software to you for your use of 50 // MStar Software in conjunction with your or your customer`s product 51 // ("Services"). 52 // You understand and agree that, except otherwise agreed by both parties in 53 // writing, Services are provided on an "AS IS" basis and the warranty 54 // disclaimer set forth in Section 4 above shall apply. 55 // 56 // 6. Nothing contained herein shall be construed as by implication, estoppels 57 // or otherwise: 58 // (a) conferring any license or right to use MStar name, trademark, service 59 // mark, symbol or any other identification; 60 // (b) obligating MStar or any of its affiliates to furnish any person, 61 // including without limitation, you and your customers, any assistance 62 // of any kind whatsoever, or any information; or 63 // (c) conferring any license or right under any intellectual property right. 64 // 65 // 7. These terms shall be governed by and construed in accordance with the laws 66 // of Taiwan, R.O.C., excluding its conflict of law rules. 67 // Any and all dispute arising out hereof or related hereto shall be finally 68 // settled by arbitration referred to the Chinese Arbitration Association, 69 // Taipei in accordance with the ROC Arbitration Law and the Arbitration 70 // Rules of the Association by three (3) arbitrators appointed in accordance 71 // with the said Rules. 72 // The place of arbitration shall be in Taipei, Taiwan and the language shall 73 // be English. 74 // The arbitration award shall be final and binding to both parties. 75 // 76 //****************************************************************************** 77 //<MStar Software> 78 /*************************************************************************** 79 * 80 * Copyright ?2008-2010 MStar Semiconductor, Inc. All Rights Reserved 81 * 82 **************************************************************************/ 83 /** \file 84 * \brief This is the header file for RAWLOB format constant. 85 */ 86 #if defined (MSOS_TYPE_LINUX) 87 #ifndef FRHSL_RAWLOB_H 88 #define FRHSL_RAWLOB_H 89 90 /******************************************************************************* 91 ** Constants 92 *******************************************************************************/ 93 94 /** Id value setting boundary between representation of 16bit and 32bit log 95 * point IDs. 96 */ 97 #define FR_HSL_TRANSITION_ID 0xFFFF 98 99 /** If over 0xff00, it must cut off the high and low bytes... 100 * 101 */ 102 103 104 105 /* RAWLOB format 106 107 Timer Wrap (1-byte message type only): type(1 byte) 108 Simeple(SP) message (5-byte header only): type(1 byte), ID(2 bytes), time stamp(2 bytes) 109 Variable-length(VL) message (5-byte header + 3-bytes packet counts + n*(3-bytes packets) ): 110 111 Add sync marker every 7 bytes 112 */ 113 114 // TODO: remove this 3 types later 115 #define HSL_RAWLOB_TW HSL_RAWLOB_MSG_TYPE_TW_CHAN0 116 #define HSL_RAWLOB_SP HSL_RAWLOB_MSG_TYPE_SP_CHAN0 117 #define HSL_RAWLOB_VL HSL_RAWLOB_MSG_TYPE_VL_CHAN0 118 119 // synchronization marker 120 #define HSL_RAWLOB_SYNC_MARKER 0x20 121 #define HSL_RAWLOB_SYNC_MARKER_INTERVAL 7 122 123 // message types, 4 channels per message type 124 // TimerWrap(TW): 125 #define HSL_RAWLOB_MSG_TYPE_TW_CHAN0 0x17 126 #define HSL_RAWLOB_MSG_TYPE_TW_CHAN1 0x1C 127 #define HSL_RAWLOB_MSG_TYPE_TW_CHAN2 0x27 128 #define HSL_RAWLOB_MSG_TYPE_TW_CHAN3 0x37 129 // Simple(SP) Log Point 130 #define HSL_RAWLOB_MSG_TYPE_SP_CHAN0 0x13 131 #define HSL_RAWLOB_MSG_TYPE_SP_CHAN1 0x73 132 #define HSL_RAWLOB_MSG_TYPE_SP_CHAN2 0x23 133 #define HSL_RAWLOB_MSG_TYPE_SP_CHAN3 0x33 134 // Variable-Length(VL) Log Point 135 #define HSL_RAWLOB_MSG_TYPE_VL_CHAN0 0x12 136 #define HSL_RAWLOB_MSG_TYPE_VL_CHAN1 0x72 137 #define HSL_RAWLOB_MSG_TYPE_VL_CHAN2 0x22 138 #define HSL_RAWLOB_MSG_TYPE_VL_CHAN3 0x32 139 140 // payload markers 141 #define HSL_RAWLOB_MORE_PAYLOAD_MARKER 0x11 142 #define HSL_RAWLOB_LAST_PAYLOAD_MARKER 0x10 143 144 145 146 /* length settings */ 147 #define HSL_RAWLOB_LENGTH_OF_SYNC_MARKER 1 148 #define HSL_RAWLOB_LENGTH_OF_MSG_TYPE 1 149 #define HSL_RAWLOB_LENGTH_OF_MSG_FIRST_ID 2 150 #define HSL_RAWLOB_LENGTH_OF_TIME_STAMP 2 151 #define HSL_RAWLOB_LENGTH_OF_HEADER (HSL_RAWLOB_LENGTH_OF_MSG_TYPE + HSL_RAWLOB_LENGTH_OF_MSG_FIRST_ID + HSL_RAWLOB_LENGTH_OF_TIME_STAMP) 152 #define HSL_RAWLOB_LENGTH_OF_PAYLOAD_MARKER 1 153 #define HSL_RAWLOB_LENGTH_OF_PAYLOAD 2 154 #define HSL_RAWLOB_LENGTH_OF_PACKET (HSL_RAWLOB_LENGTH_OF_PAYLOAD_MARKER + HSL_RAWLOB_LENGTH_OF_PAYLOAD) 155 156 #define HSL_RAWLOB_LENGTH_OF_TW_MSG HSL_RAWLOB_LENGTH_OF_MSG_TYPE 157 #define HSL_RAWLOB_LENGTH_OF_SP_MSG HSL_RAWLOB_LENGTH_OF_HEADER 158 #define HSL_RAWLOB_LENGTH_OF_VL_MSG(u32Packets) (HSL_RAWLOB_LENGTH_OF_HEADER + HSL_RAWLOB_LENGTH_OF_PACKET*(u32Packets)) 159 160 /* offset settings */ 161 #define HSL_RAWLOB_OFFSET_OF_MSG_TYPE 0 162 #define HSL_RAWLOB_OFFSET_OF_MSG_ID HSL_RAWLOB_LENGTH_OF_MSG_TYPE 163 #define HSL_RAWLOB_OFFSET_OF_TIME_STAMP (HSL_RAWLOB_LENGTH_OF_MSG_TYPE + HSL_RAWLOB_LENGTH_OF_TIME_STAMP) 164 165 // 1 packet = 3 bytes = payload marker(1 byte) + payload(2 bytes) 166 #define HSL_RAWLOB_OFFSET_OF_PAYLOAD_MARKER_IN_PACKET 0 167 #define HSL_RAWLOB_OFFSET_OF_PAYLOAD_IN_PACKET HSL_RAWLOB_LENGTH_OF_PAYLOAD_MARKER 168 #define HSL_RAWLOB_OFFSET_OF_PACKET(u32nthPacket) (HSL_RAWLOB_LENGTH_OF_HEADER+HSL_RAWLOB_LENGTH_OF_PACKET*(u32nthPacket)) 169 170 #define HSL_RAWLOB_NUMBER_OF_PACKETS_FOR_PACKET_COUNTS 1 171 #define HSL_RAWLOB_NUMBER_OF_PACKETS_FOR_ADDRESS 2 172 #define HSL_RAWLOB_NUMBER_OF_PACKETS_FOR_SECOND_ID 1 173 174 // special purpose constant 175 #define HSL_RAWLOB_INVALID_PRINTF_MSG_ID 0x4444 // if user uses printf directly 176 177 #define HSL_RAWLOB_DROPPED_MSG_ID 0x83C2 // if ring buffer is full 178 179 180 /******************************************************************************* 181 ** Macros 182 *******************************************************************************/ 183 184 185 #endif 186 #endif 187 /* END OF FILE */ 188