xref: /utopia/UTPA2-700.0.x/modules/hsl/api/hsl/frhsl_RAWLOB.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)

//<MStar Software>
//******************************************************************************
// MStar Software
// Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
// All software, firmware and related documentation herein ("MStar Software") are
// intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
// law, including, but not limited to, copyright law and international treaties.
// Any use, modification, reproduction, retransmission, or republication of all
// or part of MStar Software is expressly prohibited, unless prior written
// permission has been granted by MStar.
//
// By accessing, browsing and/or using MStar Software, you acknowledge that you
// have read, understood, and agree, to be bound by below terms ("Terms") and to
// comply with all applicable laws and regulations:
//
// 1. MStar shall retain any and all right, ownership and interest to MStar
//    Software and any modification/derivatives thereof.
//    No right, ownership, or interest to MStar Software and any
//    modification/derivatives thereof is transferred to you under Terms.
//
// 2. You understand that MStar Software might include, incorporate or be
//    supplied together with third party`s software and the use of MStar
//    Software may require additional licenses from third parties.
//    Therefore, you hereby agree it is your sole responsibility to separately
//    obtain any and all third party right and license necessary for your use of
//    such third party`s software.
//
// 3. MStar Software and any modification/derivatives thereof shall be deemed as
//    MStar`s confidential information and you agree to keep MStar`s
//    confidential information in strictest confidence and not disclose to any
//    third party.
//
// 4. MStar Software is provided on an "AS IS" basis without warranties of any
//    kind. Any warranties are hereby expressly disclaimed by MStar, including
//    without limitation, any warranties of merchantability, non-infringement of
//    intellectual property rights, fitness for a particular purpose, error free
//    and in conformity with any international standard.  You agree to waive any
//    claim against MStar for any loss, damage, cost or expense that you may
//    incur related to your use of MStar Software.
//    In no event shall MStar be liable for any direct, indirect, incidental or
//    consequential damages, including without limitation, lost of profit or
//    revenues, lost or damage of data, and unauthorized system use.
//    You agree that this Section 4 shall still apply without being affected
//    even if MStar Software has been modified by MStar in accordance with your
//    request or instruction for your use, except otherwise agreed by both
//    parties in writing.
//
// 5. If requested, MStar may from time to time provide technical supports or
//    services in relation with MStar Software to you for your use of
//    MStar Software in conjunction with your or your customer`s product
//    ("Services").
//    You understand and agree that, except otherwise agreed by both parties in
//    writing, Services are provided on an "AS IS" basis and the warranty
//    disclaimer set forth in Section 4 above shall apply.
//
// 6. Nothing contained herein shall be construed as by implication, estoppels
//    or otherwise:
//    (a) conferring any license or right to use MStar name, trademark, service
//        mark, symbol or any other identification;
//    (b) obligating MStar or any of its affiliates to furnish any person,
//        including without limitation, you and your customers, any assistance
//        of any kind whatsoever, or any information; or
//    (c) conferring any license or right under any intellectual property right.
//
// 7. These terms shall be governed by and construed in accordance with the laws
//    of Taiwan, R.O.C., excluding its conflict of law rules.
//    Any and all dispute arising out hereof or related hereto shall be finally
//    settled by arbitration referred to the Chinese Arbitration Association,
//    Taipei in accordance with the ROC Arbitration Law and the Arbitration
//    Rules of the Association by three (3) arbitrators appointed in accordance
//    with the said Rules.
//    The place of arbitration shall be in Taipei, Taiwan and the language shall
//    be English.
//    The arbitration award shall be final and binding to both parties.
//
//******************************************************************************
//<MStar Software>
/***************************************************************************
 *
 * Copyright ?2008-2010 MStar Semiconductor, Inc. All Rights Reserved
 *
 **************************************************************************/
/** \file
 * \brief This is the header file for RAWLOB format constant.
 */
#if defined (MSOS_TYPE_LINUX)
#ifndef FRHSL_RAWLOB_H
#define FRHSL_RAWLOB_H

/*******************************************************************************
** Constants
*******************************************************************************/

/** Id value setting boundary between representation of 16bit and 32bit log
* point IDs.
*/
#define FR_HSL_TRANSITION_ID 0xFFFF

/** If over 0xff00, it must cut off the high and low bytes...
*
*/



/* RAWLOB format

    Timer Wrap (1-byte message type only):                  type(1 byte)
    Simeple(SP) message (5-byte header only):           type(1 byte), ID(2 bytes), time stamp(2 bytes)
    Variable-length(VL) message (5-byte header + 3-bytes packet counts + n*(3-bytes packets) ):

    Add sync marker every 7 bytes
*/

// TODO: remove this 3 types later
#define HSL_RAWLOB_TW  HSL_RAWLOB_MSG_TYPE_TW_CHAN0
#define HSL_RAWLOB_SP HSL_RAWLOB_MSG_TYPE_SP_CHAN0
#define HSL_RAWLOB_VL HSL_RAWLOB_MSG_TYPE_VL_CHAN0

// synchronization marker
#define HSL_RAWLOB_SYNC_MARKER                  0x20
#define HSL_RAWLOB_SYNC_MARKER_INTERVAL 7

// message types, 4 channels per message type
// TimerWrap(TW):
#define HSL_RAWLOB_MSG_TYPE_TW_CHAN0    0x17
#define HSL_RAWLOB_MSG_TYPE_TW_CHAN1    0x1C
#define HSL_RAWLOB_MSG_TYPE_TW_CHAN2    0x27
#define HSL_RAWLOB_MSG_TYPE_TW_CHAN3    0x37
// Simple(SP) Log Point
#define HSL_RAWLOB_MSG_TYPE_SP_CHAN0    0x13
#define HSL_RAWLOB_MSG_TYPE_SP_CHAN1    0x73
#define HSL_RAWLOB_MSG_TYPE_SP_CHAN2    0x23
#define HSL_RAWLOB_MSG_TYPE_SP_CHAN3    0x33
// Variable-Length(VL) Log Point
#define HSL_RAWLOB_MSG_TYPE_VL_CHAN0    0x12
#define HSL_RAWLOB_MSG_TYPE_VL_CHAN1    0x72
#define HSL_RAWLOB_MSG_TYPE_VL_CHAN2    0x22
#define HSL_RAWLOB_MSG_TYPE_VL_CHAN3    0x32

// payload markers
#define HSL_RAWLOB_MORE_PAYLOAD_MARKER  0x11
#define HSL_RAWLOB_LAST_PAYLOAD_MARKER  0x10



/* length settings */
#define HSL_RAWLOB_LENGTH_OF_SYNC_MARKER            1
#define HSL_RAWLOB_LENGTH_OF_MSG_TYPE                  1
#define HSL_RAWLOB_LENGTH_OF_MSG_FIRST_ID           2
#define HSL_RAWLOB_LENGTH_OF_TIME_STAMP            2
#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)
#define HSL_RAWLOB_LENGTH_OF_PAYLOAD_MARKER    1
#define HSL_RAWLOB_LENGTH_OF_PAYLOAD                   2
#define HSL_RAWLOB_LENGTH_OF_PACKET                    (HSL_RAWLOB_LENGTH_OF_PAYLOAD_MARKER + HSL_RAWLOB_LENGTH_OF_PAYLOAD)

#define HSL_RAWLOB_LENGTH_OF_TW_MSG                     HSL_RAWLOB_LENGTH_OF_MSG_TYPE
#define HSL_RAWLOB_LENGTH_OF_SP_MSG                     HSL_RAWLOB_LENGTH_OF_HEADER
#define HSL_RAWLOB_LENGTH_OF_VL_MSG(u32Packets) (HSL_RAWLOB_LENGTH_OF_HEADER + HSL_RAWLOB_LENGTH_OF_PACKET*(u32Packets))

/* offset settings */
#define HSL_RAWLOB_OFFSET_OF_MSG_TYPE                  0
#define HSL_RAWLOB_OFFSET_OF_MSG_ID                 HSL_RAWLOB_LENGTH_OF_MSG_TYPE
#define HSL_RAWLOB_OFFSET_OF_TIME_STAMP          (HSL_RAWLOB_LENGTH_OF_MSG_TYPE + HSL_RAWLOB_LENGTH_OF_TIME_STAMP)

// 1 packet = 3 bytes = payload marker(1 byte) + payload(2 bytes)
#define HSL_RAWLOB_OFFSET_OF_PAYLOAD_MARKER_IN_PACKET 0
#define HSL_RAWLOB_OFFSET_OF_PAYLOAD_IN_PACKET              HSL_RAWLOB_LENGTH_OF_PAYLOAD_MARKER
#define HSL_RAWLOB_OFFSET_OF_PACKET(u32nthPacket)           (HSL_RAWLOB_LENGTH_OF_HEADER+HSL_RAWLOB_LENGTH_OF_PACKET*(u32nthPacket))

#define HSL_RAWLOB_NUMBER_OF_PACKETS_FOR_PACKET_COUNTS 1
#define HSL_RAWLOB_NUMBER_OF_PACKETS_FOR_ADDRESS            2
#define HSL_RAWLOB_NUMBER_OF_PACKETS_FOR_SECOND_ID          1

// special purpose constant
#define HSL_RAWLOB_INVALID_PRINTF_MSG_ID  0x4444 // if user uses printf directly

#define HSL_RAWLOB_DROPPED_MSG_ID  0x83C2 // if ring buffer is full


/*******************************************************************************
** Macros
*******************************************************************************/


#endif
#endif
/* END OF FILE */