diff options
Diffstat (limited to 'octdev_types.h')
| -rw-r--r-- | octdev_types.h | 330 |
1 files changed, 330 insertions, 0 deletions
diff --git a/octdev_types.h b/octdev_types.h new file mode 100644 index 0000000..d8d1e0a --- /dev/null +++ b/octdev_types.h @@ -0,0 +1,330 @@ +/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
+
+File: OCTDEV_TYPES.h
+
+Copyright (c) 2015 Octasic Inc. All rights reserved.
+
+Description:
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+
+Release: OCTSDR Software Development Kit OCTSDR_GSM-02.03.00-B560 (2015/08/07)
+
+$Revision: $
+
+\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
+
+#ifndef __OCTDEV_TYPES_H__
+#define __OCTDEV_TYPES_H__
+
+
+/***************************** INCLUDE FILES *******************************/
+#include <limits.h>
+
+
+/************************ COMMON DEFINITIONS *******************************/
+
+/*-------------------------------------------------------------------------------------
+ API Data Types
+-------------------------------------------------------------------------------------*/
+
+
+#ifndef NULL
+#ifdef __cplusplus
+#define NULL 0
+#else
+#define NULL ((void *)0)
+#endif
+#endif
+
+#if SHRT_MAX == 32767
+ /* short is 16-bit */
+ typedef unsigned short tOCT_UINT16;
+ typedef short tOCT_INT16;
+#elif INT_MAX == 32767
+ /* integer is 16-bit */
+ typedef unsigned int tOCT_UINT16;
+ typedef int tOCT_INT16;
+#else
+ /* unexpected 16-bit type */
+ #error Cannot determine 16-bit type
+#endif
+
+#if INT_MAX == 2147483647L
+ /* integer is 32-bit */
+ typedef int tOCT_INT32;
+ typedef unsigned int tOCT_UINT32;
+#elif LONG_MAX == 2147483647L
+ /* long is 32-bit */
+ typedef long tOCT_INT32;
+ typedef unsigned long tOCT_UINT32;
+#else
+ /* unexpected 32-bit type */
+ #error Cannot determine 32-bit type
+#endif
+
+typedef long long tOCT_INT64;
+typedef unsigned long long tOCT_UINT64;
+
+typedef char tOCT_INT8;
+typedef unsigned char tOCT_UINT8;
+
+
+/*-------------------------------------------------------------------------------------
+ TRUE/FALSE
+-------------------------------------------------------------------------------------*/
+/*-------------------------------------------------------------------------------------
+ tOCT_BOOL32 :
+-------------------------------------------------------------------------------------*/
+#define tOCT_BOOL32 tOCT_UINT32
+
+#define cOCT_TRUE 1
+#define cOCT_FALSE 0
+
+/*-------------------------------------------------------------------------------------
+ Generic Timeout value
+-------------------------------------------------------------------------------------*/
+#define cOCTDEV_TIMEOUT_FOREVER 0xFFFFFFFF
+
+
+/*--------------------------------------------------------------------------
+ ENDIAN Determination
+
+ _OCT_ENDIAN_TYPE_BE_: Defined when target is Big Endian
+ _OCT_ENDIAN_TYPE_LE_: Defined when target is Little Endian
+
+ These must be set by the user. If not set the system will try to
+ automatically determine them based on some common compiler #define
+ values.
+
+----------------------------------------------------------------------------*/
+
+#if !defined( _OCT_ENDIAN_TYPE_BE_ ) && !defined( _OCT_ENDIAN_TYPE_LE_ )
+ /* Not Set - try to determine automatically */
+
+ /* Look for Intel target */
+ #if defined( __OCT_ENV_OPUS__ ) || defined( _M_OPUS1 ) || defined( _M_OPUS2 ) || defined( _M_OPUS3 )
+ #define _OCT_ENDIAN_TYPE_BE_
+ #define _OCT_PLATFORM_OPUS_
+ #elif defined( _M_IX86 ) || defined(__x86_64__)
+ #define _OCT_ENDIAN_TYPE_LE_
+ #define _OCT_PLATFORM_X86_
+ #elif defined( __i386 )
+ #define _OCT_ENDIAN_TYPE_LE_
+ #define _OCT_PLATFORM_X86_
+ #elif defined( i386 )
+ #define _OCT_ENDIAN_TYPE_LE_
+ #define _OCT_PLATFORM_X86_
+ /* Look for Motorola PPC target */
+ #elif defined( _M_MPPC ) || defined( _M_PPC ) || defined( __ppc__ ) || defined( __PPC )
+ #define _OCT_ENDIAN_TYPE_BE_
+ #define _OCT_PLATFORM_PPC_
+ /* Look for Sparc target */
+ #elif defined( __sparc )
+ #define _OCT_ENDIAN_TYPE_BE_
+ #define _OCT_PLATFORM_SPARC_
+ #elif defined( __sun__ )
+ #define _OCT_ENDIAN_TYPE_BE_
+ #define _OCT_PLATFORM_SPARC_
+ /* Look for ARM target */
+ #elif defined( __ARMEL__ )
+ #define _OCT_ENDIAN_TYPE_LE_
+ #define _OCT_PLATFORM_ARM_
+ /* Look for MIPS target */
+ #elif defined( __mips__ ) || defined( __MIPSEB )
+ #define _OCT_ENDIAN_TYPE_BE_
+ #define _OCT_PLATFORM_MIPS_
+ /* others */
+ #elif defined( CPU )
+ #if CPU==PPC860
+ #define _OCT_ENDIAN_TYPE_BE_
+ #define _OCT_PLATFORM_PPC_
+ #endif
+ #endif
+#endif
+
+/* Now insure the endian format is set properly */
+#if !defined( _OCT_ENDIAN_TYPE_BE_ ) && !defined( _OCT_ENDIAN_TYPE_LE_ )
+ #error Processor Endian not determined
+#endif
+#if defined( _OCT_ENDIAN_TYPE_BE_ ) && defined( _OCT_ENDIAN_TYPE_LE_ )
+ #error Processor Endian Set to both Values
+#endif
+
+/*--------------------------------------------------------------------------
+ PLATFORM Determination
+
+ OCT_WINDOWS_ENV : Defined when target running under windows
+ OCT_LINUX_ENV : Defined when target running under linux
+ OCT_OPUS_ENV : OPUS env
+ OCT_UNKNOWN_ENV : Unknown env
+
+----------------------------------------------------------------------------*/
+#define __OCTDEV_TYPE_STR2__(x) #x
+#define __OCTDEV_TYPE_STR1__(x) __OCTDEV_TYPE_STR2__(x)
+#define __OCTDEV_TYPE_WARNLOC__ __FILE__ "("__OCTDEV_TYPE_STR1__(__LINE__)") : Warning Msg: "
+
+#if defined( __OCT_ENV_OPUS__ ) || defined( _M_OPUS1 ) || defined( _M_OPUS2 ) || defined( _M_OPUS3 )
+ #define OCT_ENV_TYPE_OPUS
+ #define OCT_ENV_TYPE_OCTSYS
+#ifndef NDEBUG
+ #define OCT_ENV_MODE_DEBUG
+#endif
+#elif defined( _LINUX_ ) || defined( __linux__ )
+ #define OCT_ENV_TYPE_LINUX
+ #define OCT_ENV_TYPE_OCTOS
+#ifndef NDEBUG
+ #define OCT_ENV_MODE_DEBUG
+#endif
+#elif defined( _WIN32 ) || defined( WIN32 ) || defined( __WIN32__ ) || defined( _WIN32_ ) || defined( WIN32S ) || defined( _WIN64 ) || defined( WIN64 )
+ #define OCT_ENV_TYPE_WINDOWS
+ #define OCT_ENV_TYPE_OCTOS
+#ifdef _DEBUG
+ #define OCT_ENV_MODE_DEBUG
+#endif
+#else
+ #define OCT_ENV_TYPE_UNKNOWN
+ #pragma message(__OCTDEV_TYPE_WARNLOC__"Environment platform not determined")
+#endif
+
+/*--------------------------------------------------------------------------
+ POINTER type definition
+----------------------------------------------------------------------------*/
+#if defined( OCT_ENV_TYPE_WINDOWS )
+#include <basetsd.h>
+
+#define tOCT_UINT_PTR UINT_PTR
+#define tOCT_INT_PTR INT_PTR
+
+#elif defined( OCT_ENV_TYPE_LINUX )
+#include <inttypes.h>
+
+#define tOCT_UINT_PTR uintptr_t
+#define tOCT_INT_PTR intptr_t
+
+#elif defined( OCT_ENV_TYPE_OCTSYS )
+#include <stdint.h>
+
+#define tOCT_UINT_PTR uintptr_t
+#define tOCT_INT_PTR intptr_t
+
+#else
+ #pragma message(__OCTDEV_TYPE_WARNLOC__"Environment pointer determined")
+
+
+#endif /* OCT_ENV_TYPE_WINDOWS */
+
+
+/*-------------------------------------------------------------------------------------
+ Generic IP Address
+-------------------------------------------------------------------------------------*/
+
+/*-------------------------------------------------------------------------------------
+ tOCTDEV_IP_VERSION_ENUM :
+-------------------------------------------------------------------------------------*/
+#define tOCTDEV_IP_VERSION_ENUM tOCT_UINT32
+
+#define cOCTDEV_IP_VERSION_ENUM_4 0 /* IP address version 4 */
+#define cOCTDEV_IP_VERSION_ENUM_6 1 /* IP address version 6 */
+#define cOCTDEV_IP_VERSION_ENUM_INVALID 0xFFFFFFFF
+
+/*-------------------------------------------------------------------------------------
+ tOCTDEV_IP_ADDRESS
+ IP address structure
+
+ Members:
+ ulIpVersion
+ Default: cOCTDEV_IP_VERSION_ENUM_4
+ Version of the IP address
+ aulIpAddress
+ Ip address, Version 4 -> aulIpAddress[0] only.
+-------------------------------------------------------------------------------------*/
+typedef struct
+{
+ tOCTDEV_IP_VERSION_ENUM ulIpVersion;
+ tOCT_UINT32 aulIpAddress[4];
+
+} tOCTDEV_IP_ADDRESS;
+
+/*-------------------------------------------------------------------------------------
+ Generic UDP Address
+-------------------------------------------------------------------------------------*/
+#define cOCTDEV_UDP_PORT_INVALID 0xFFFFFFFF /* Invalid UDP port specification. */
+
+/*-------------------------------------------------------------------------------------
+ tOCTDEV_UDP_ADDRESS
+ UDP address structure
+
+ Members:
+ IpAddress
+ IP version and address.
+ ulUdpPort
+ Default: cOCTDEV_UDP_PORT_INVALID
+ UDP port used with IP address
+-------------------------------------------------------------------------------------*/
+typedef struct
+{
+ tOCTDEV_IP_ADDRESS IpAddress;
+ tOCT_UINT32 ulUdpPort;
+
+} tOCTDEV_UDP_ADDRESS;
+
+/*-------------------------------------------------------------------------------------
+ Generic TCP Address
+-------------------------------------------------------------------------------------*/
+#define cOCTDEV_TCP_PORT_INVALID 0xFFFFFFFF /* Invalid TCP port specification. */
+
+/*-------------------------------------------------------------------------------------
+ tOCTDEV_TCP_ADDRESS
+ TCP address structure
+
+ Members:
+ IpAddress
+ IP version and address.
+ ulTcpPort
+ Default: cOCTDEV_TCP_PORT_INVALID
+ TCP port used with IP address
+-------------------------------------------------------------------------------------*/
+typedef struct
+{
+ tOCTDEV_IP_ADDRESS IpAddress;
+ tOCT_UINT32 ulTcpPort;
+
+} tOCTDEV_TCP_ADDRESS;
+
+/*-------------------------------------------------------------------------------------
+ Generic MAC Address
+-------------------------------------------------------------------------------------*/
+#define cOCTDEV_MAC_ADDRESS_BYTE_COUNT 6
+
+/*-------------------------------------------------------------------------------------
+ tOCTDEV_MAC_ADDRESS
+ MAC address structure
+
+ Members:
+ abyReserved
+ Reserved fields inserted to ensure that the structure is an integer multiple of
+ DWORDS.
+ abyMacAddress
+ MAC address; abyMacAddress[0] = msb, abyMacAddress[5] = lsb.
+-------------------------------------------------------------------------------------*/
+typedef struct
+{
+ tOCT_UINT8 abyReserved[2];
+ tOCT_UINT8 abyMacAddress[cOCTDEV_MAC_ADDRESS_BYTE_COUNT];
+
+} tOCTDEV_MAC_ADDRESS;
+
+
+#endif /* __OCTDEV_TYPES_H__ */
+
|