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 * Copyright (c) 2008 MStar Semiconductor, Inc. All Rights Reserved. 80 **************************************************************************/ 81 /** \file 82 * \brief This is the header file for the FrHsl ring buffer module. 83 * 84 */ 85 86 #ifndef FRHSL_RINGBUFFER_H 87 #define FRHSL_RINGBUFFER_H 88 89 #include <pthread.h> 90 91 #include "apiHSL.h" 92 #if HSL_TCPIP == true 93 #include "frhsl_autotest.h" 94 #include "frhsl_cfg.h" 95 96 #endif 97 98 #ifdef __cpluplus 99 extern "C" 100 { 101 #endif 102 103 #if defined(MSOS_TYPE_LINUX) 104 105 #include <fcntl.h> 106 #include <sys/ioctl.h> 107 #include <string.h> 108 109 enum HSLOutputType 110 { 111 HSL_UART = 'U', 112 HSL_FILE = 'F', 113 HSL_SOCKET = 'S', 114 }; 115 116 #define FR_HSL_FILE_DESCRIPTOR (HSL_UART) 117 118 #define HSL_DEVICE_PATH "/dev/hsl" 119 #define CANNOT_OPEN_MSG "Cannot open /dev/hsl\n" 120 121 #define HSL_IOC_MAGIC 'h' 122 123 #define MDRV_HSL_SET_OUTPUT_PATH _IOW(HSL_IOC_MAGIC, 1, MS_U8) 124 #define MDRV_HSL_CLEAR_OUTPUT_FILE _IO(HSL_IOC_MAGIC, 2) 125 126 #if HSL_TCPIP 127 #define PUTCS(dataptr, length, port, hsl) CmdSend(hsl, dataptr, length) 128 #define FFLUSH(port) 129 #else 130 #define PUTCS(dataptr, length, port, hsl) \ 131 {\ 132 int fd; \ 133 fd = open(HSL_DEVICE_PATH, O_RDWR); \ 134 if (fd <= 0) { \ 135 write(STDERR_FILENO, CANNOT_OPEN_MSG, strlen(CANNOT_OPEN_MSG)); \ 136 } \ 137 else \ 138 { \ 139 if (0==ioctl(fd, MDRV_HSL_SET_OUTPUT_PATH, (port)) ) \ 140 { \ 141 write(fd, (dataptr), (length)); \ 142 } \ 143 close(fd); \ 144 } \ 145 } 146 147 #define FFLUSH(port) \ 148 { \ 149 int fd; \ 150 fd = open(HSL_DEVICE_PATH, O_RDWR); \ 151 if (fd <= 0) { \ 152 write(STDERR_FILENO, CANNOT_OPEN_MSG, strlen(CANNOT_OPEN_MSG)); \ 153 } \ 154 else \ 155 { \ 156 if (0==ioctl(fd, MDRV_HSL_SET_OUTPUT_PATH, (port)) ) \ 157 { \ 158 fsync(fd); \ 159 } \ 160 close(fd); \ 161 } \ 162 } 163 #endif 164 165 #define HSL_CLEAR_OUTPUT_FILE() \ 166 { \ 167 int fd; \ 168 fd = open(HSL_DEVICE_PATH, O_RDWR); \ 169 if (fd <= 0) { \ 170 write(STDERR_FILENO, CANNOT_OPEN_MSG, strlen(CANNOT_OPEN_MSG)); \ 171 } \ 172 else \ 173 { \ 174 ioctl(fd, MDRV_HSL_CLEAR_OUTPUT_FILE); \ 175 close(fd); \ 176 } \ 177 } 178 179 #else 180 181 #define FR_HSL_FILE_DESCRIPTOR (STDOUT_FILENO) 182 183 #define PUTCS(dataptr, length, port) \ 184 { \ 185 MS_U32 i; \ 186 for( i=0 ; i<length ; i++) \ 187 { \ 188 write(port, dataptr, length); \ 189 } \ 190 } 191 192 #define FFLUSH(port) fsync(port) 193 194 #endif 195 196 #define BUFFER_FLAG_NONE 0x0000 197 #define BUFFER_FLAG_DUMP 0x0001 198 #define BUFFER_FLAG_EMERGENCY_DUMP 0x0002 199 #define BUFFER_FLAG_TX 0x0004 200 #define BUFFER_FLAG_FLUSH 0x0008 201 202 struct stListNode; 203 204 MS_BOOL bufferInitialize(stHslController* const _hsl, const MS_PHYADDR physAddr, const MS_U32 size); 205 MS_BOOL bufferFinalize(stHslController* const _hsl); 206 MS_BOOL bufferAllocateWrite(stHslController* const _hsl, const MS_U32 dataSize, stListNode** const s_dataInfo); 207 MS_BOOL bufferDumpOldestDataSegment(stHslController* const _hsl); 208 void bufferAcknowledgeWrite(stHslController* const _hsl, stListNode* const s_dataInfo); 209 MS_BOOL bufferProcessCommand(stHslController* const _hsl, CmdInfo* const pCmd); 210 211 // Function prototypes 212 void *bufferWriteThread(void*); // output thread function 213 MS_BOOL initThread( hslThread* aThread); 214 215 #ifdef __cpluplus 216 } 217 #endif 218 219 #endif // FRHSL_RINGBUFFER_H 220