mipi_syst.h

/*
Copyright (c) 2018, MIPI Alliance, Inc.
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
 
* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
 
* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in
  the documentation and/or other materials provided with the
  distribution.
 
* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived
  from this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
/*
 * Contributors:
 * Norbert Schulz (Intel Corporation) - Initial API and implementation
 */
 
#ifndef MIPI_SYST_H_INCLUDED
#define MIPI_SYST_H_INCLUDED
 
/* SyS-T API version information
 */
#define MIPI_SYST_VERSION_MAJOR 1   
#define MIPI_SYST_VERSION_MINOR 0   
#define MIPI_SYST_VERSION_PATCH 0   
#define MIPI_SYST_CONFORMANCE_LEVEL 30
 
#define MIPI_SYST_MAKE_VERSION_CODE(ma, mi, p) (((ma) << 16) | ((mi)<<8) | (p))
 
#define MIPI_SYST_VERSION_CODE MIPI_SYST_MAKE_VERSION_CODE(\
  MIPI_SYST_VERSION_MAJOR,\
  MIPI_SYST_VERSION_MINOR,\
  MIPI_SYST_VERSION_PATCH)
 
/* Macros to trick numeric values like __LINE__ into a string
 */
#define _MIPI_SYST_STRINGIFY(x) #x
#define _MIPI_SYST_CPP_TOSTR(x) _MIPI_SYST_STRINGIFY(x)
 
#define _MIPI_SYST_VERSION_STRING(a, b, c)\
  _MIPI_SYST_CPP_TOSTR(a)"."_MIPI_SYST_CPP_TOSTR(b)"."_MIPI_SYST_CPP_TOSTR(c)
 
#define MIPI_SYST_VERSION_STRING \
  _MIPI_SYST_VERSION_STRING(\
    MIPI_SYST_VERSION_MAJOR,\
    MIPI_SYST_VERSION_MINOR,\
    MIPI_SYST_VERSION_PATCH)
 
#ifndef MIPI_SYST_COMPILER_INCLUDED
#include "mipi_syst/compiler.h"
#endif
 
/* String hash macros for compile time computation of catalog ID's.
 * Notes:
 *    These macros will only be used with optimized builds, otherwise
 *    a lot of runtime code will be generated.
 *
 *    Only the last 64 bytes of the string are considered for hashing
 */
#define _MIPI_SYST_HASH1(s,i,x,l)  (x*65599u+(mipi_syst_u8)s[(i)<(l)?((l)-1-(i)):(l)])
#define _MIPI_SYST_HASH4(s,i,x,l)  _MIPI_SYST_HASH1(s,i,_MIPI_SYST_HASH1(s,i+1,_MIPI_SYST_HASH1(s,i+2,_MIPI_SYST_HASH1(s,i+3,x,l),l),l),l)
#define _MIPI_SYST_HASH16(s,i,x,l) _MIPI_SYST_HASH4(s,i,_MIPI_SYST_HASH4(s,i+4,_MIPI_SYST_HASH4(s,i+8,_MIPI_SYST_HASH4(s,i+12,x,l),l),l),l)
#define _MIPI_SYST_HASH64(s,i,x,l) _MIPI_SYST_HASH16(s,i,_MIPI_SYST_HASH16(s,i+16,_MIPI_SYST_HASH16(s,i+32,_MIPI_SYST_HASH16(s,i+48,x,l),l),l),l)
 
#define _MIPI_SYST_HASH_x65599(s,l) ((mipi_syst_u32)_MIPI_SYST_HASH64(s,0,0,l))
 
#define _MIPI_SYST_HASH_AT_CPP_TIME(str, offset) (_MIPI_SYST_HASH_x65599(str, sizeof(str)-1) + (offset))
#define _MIPI_SYST_HASH_AT_RUN_TIME(str, offset) (mipi_syst_hash_x65599(str, sizeof(str)-1) + (offset))
 
#if defined(_MIPI_SYST_OPTIMIZER_ON)
#define MIPI_SYST_HASH(a, b) _MIPI_SYST_HASH_AT_CPP_TIME((a), (b))
#else
#define MIPI_SYST_HASH(a, b) _MIPI_SYST_HASH_AT_RUN_TIME((a),(b))
#endif
 
#if defined(__cplusplus)
extern "C" {
#endif
 
enum mipi_syst_msgtype {
  MIPI_SYST_TYPE_BUILD = 0,          
  MIPI_SYST_TYPE_SHORT32 = 1,        
  MIPI_SYST_TYPE_STRING = 2,         
  MIPI_SYST_TYPE_CATALOG = 3,        
  MIPI_SYST_TYPE_RAW = 6,            
  MIPI_SYST_TYPE_SHORT64 = 7,        
  MIPI_SYST_TYPE_CLOCK = 8,          
  MIPI_SYST_TYPE_MAX
};
 
enum mipi_syst_subtype_string {
  MIPI_SYST_STRING_GENERIC = 1,        
  MIPI_SYST_STRING_FUNCTIONENTER = 2,  
  MIPI_SYST_STRING_FUNCTIONEXIT = 3,   
  MIPI_SYST_STRING_INVALIDPARAM = 5,   
  MIPI_SYST_STRING_ASSERT = 7,         
  MIPI_SYST_STRING_PRINTF_32 = 11,     
  MIPI_SYST_STRING_PRINTF_64 = 12,     
  MIPI_SYST_STRING_MAX
};
 
enum mipi_syst_subtype_catalog {
  MIPI_SYST_CATALOG_ID32_P32 = 1,   
  MIPI_SYST_CATALOG_ID64_P32 = 2,   
  MIPI_SYST_CATALOG_ID32_P64 = 5,   
  MIPI_SYST_CATALOG_ID64_P64 = 6,   
  MIPI_SYST_CATALOG_MAX
};
 
enum mipi_syst_subtype_clock{
  MIPI_SYST_CLOCK_TRANSPORT_SYNC   =  1,  
  MIPI_SYST_CLOCK_MAX
};
 
enum mipi_syst_subtype_build {
  MIPI_SYST_BUILD_ID_COMPACT32  = 0, 
  MIPI_SYST_BUILD_ID_COMPACT64  = 1, 
  MIPI_SYST_BUILD_ID_LONG       = 2, 
  MIPI_SYST_BUILD_MAX
};
 
struct mipi_syst_header;
struct mipi_syst_handle;
struct mipi_syst_scatter_prog;
 
struct mipi_syst_guid {
  union {
    mipi_syst_u8  b[16];
    mipi_syst_u64 ll[2];
  } u;
};
 
#define MIPI_SYST_GEN_GUID(l1, w1, w2, w3, l2) \
  {{\
    (mipi_syst_u8)((mipi_syst_u32)(l1) >> 24), \
    (mipi_syst_u8)((mipi_syst_u32)(l1) >> 16), \
    (mipi_syst_u8)((mipi_syst_u32)(l1) >>  8), \
    (mipi_syst_u8)((mipi_syst_u32)(l1) >>  0), \
    (mipi_syst_u8)((mipi_syst_u16)(w1) >>  8), \
    (mipi_syst_u8)((mipi_syst_u16)(w1) >>  0), \
    (mipi_syst_u8)((mipi_syst_u16)(w2) >>  8), \
    (mipi_syst_u8)((mipi_syst_u16)(w2) >>  0), \
    (mipi_syst_u8)((mipi_syst_u16)(w3) >>  8), \
    (mipi_syst_u8)((mipi_syst_u16)(w3) >>  0), \
    (mipi_syst_u8)((mipi_syst_u64)(l2) >> 40), \
    (mipi_syst_u8)((mipi_syst_u64)(l2) >> 32), \
    (mipi_syst_u8)((mipi_syst_u64)(l2) >> 24), \
    (mipi_syst_u8)((mipi_syst_u64)(l2) >> 16), \
    (mipi_syst_u8)((mipi_syst_u64)(l2) >>  8), \
    (mipi_syst_u8)((mipi_syst_u64)(l2) >>  0)  \
  }}
 
struct mipi_syst_origin {
  struct mipi_syst_guid  guid;    
  mipi_syst_u16   unit;           
};
 
#define MIPI_SYST_GEN_ORIGIN_GUID(l1, w1, w2, w3, l2 , u) \
  {\
    MIPI_SYST_GEN_GUID(l1, w1, w2, w3, l2) ,\
    u\
  }
 
#define MIPI_SYST_GEN_ORIGIN_MODULE(m , u) \
  {\
    MIPI_SYST_GEN_GUID(0,0,0, ((mipi_syst_u16)(m & 0x7F)) << 8, 0 ),\
    u\
  }
typedef void (MIPI_SYST_CALLCONV *mipi_syst_inithook_t)(struct mipi_syst_header *systh,
    const void *p);
 
typedef void (MIPI_SYST_CALLCONV *mipi_syst_destroyhook_t)(struct mipi_syst_header *systh);
 
typedef void (*mipi_syst_inithandle_hook_t)(struct mipi_syst_handle *systh);
 
typedef void (*mipi_syst_releasehandle_hook_t)(struct mipi_syst_handle *systh);
 
typedef void (*mipi_syst_msg_write_t)(
    struct mipi_syst_handle *systh,
    struct mipi_syst_scatter_prog *scatterprog,
    const void *pdesc);
 
#ifdef __cplusplus
} /* extern C */
#endif
#ifndef MIPI_SYST_PLATFORM_INCLUDED
 
#define MIPI_SYST_PCFG_ENABLE_PLATFORM_STATE_DATA
#undef MIPI_SYST_PCFG_ENABLE_PLATFORM_STATE_DATA
#define MIPI_SYST_PCFG_ENABLE_PLATFORM_HANDLE_DATA
 
#define MIPI_SYST_PCFG_ENABLE_HEAP_MEMORY
#undef MIPI_SYST_PCFG_ENABLE_HEAP_MEMORY
/* MSVC and GNU compiler 64-bit mode */
 
#if defined(_WIN64) || defined(__x86_64__) || defined (__LP64__)
#define MIPI_SYST_PCFG_ENABLE_64BIT_ADDR
#endif
#if defined(_WIN64) || defined(__x86_64__) || defined (__LP64__)
#define MIPI_SYST_PCFG_ENABLE_64BIT_IO
#endif
 
#define MIPI_SYST_PCFG_ENABLE_INLINE
 
#if MIPI_SYST_CONFORMANCE_LEVEL > 10
#define MIPI_SYST_PCFG_ENABLE_DEFAULT_SCATTER_WRITE
 
#define MIPI_SYST_PCFG_ENABLE_CATID32_API
 
#define MIPI_SYST_PCFG_ENABLE_CATID64_API
 
#define MIPI_SYST_PCFG_ENABLE_STRING_API
 
#define MIPI_SYST_PCFG_ENABLE_WRITE_API
 
#define MIPI_SYST_PCFG_ENABLE_BUILD_API
#endif /* MIPI_SYST_CONFORMANCE_LEVEL > 10 */
 
#if  MIPI_SYST_CONFORMANCE_LEVEL > 20
#define MIPI_SYST_PCFG_ENABLE_PRINTF_API
#undef MIPI_SYST_PCFG_ENABLE_PRINTF_API
#define MIPI_SYST_PCFG_PRINTF_ARGBUF_SIZE 1024
 
#endif /* #if MIPI_SYST_CONFORMANCE_LEVEL > 20 */
 
/* @} */
 
#if MIPI_SYST_CONFORMANCE_LEVEL > 10
#define MIPI_SYST_PCFG_ENABLE_ORIGIN_GUID
 
#define MIPI_SYST_PCFG_ENABLE_LOCATION_RECORD
#undef MIPI_SYST_PCFG_ENABLE_LOCATION_RECORD
#define MIPI_SYST_PCFG_ENABLE_LOCATION_ADDRESS
#undef MIPI_SYST_PCFG_ENABLE_LOCATION_ADDRESS
#define MIPI_SYST_PCFG_ENABLE_TIMESTAMP
 
#if defined(_DOXYGEN_)  /*  only for doxygen, remove the #if to enable */
#define MIPI_SYST_PCFG_LENGTH_FIELD
#endif
 
#endif
 
#if MIPI_SYST_CONFORMANCE_LEVEL > 20
#define MIPI_SYST_PCFG_ENABLE_CHECKSUM
 
#endif /* #if MIPI_SYST_CONFORMANCE_LEVEL */
 
#include "Platform.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(MIPI_SYST_PCFG_ENABLE_INLINE)
#define MIPI_SYST_INLINE static MIPI_SYST_CC_INLINE
#else
#define MIPI_SYST_INLINE MIPI_SYST_EXPORT
#endif
 
struct mipi_syst_header {
  mipi_syst_u32 systh_version; 
#if defined(MIPI_SYST_PCFG_ENABLE_PLATFORM_HANDLE_DATA)
  mipi_syst_inithandle_hook_t systh_inith;       
  mipi_syst_releasehandle_hook_t systh_releaseh; 
#endif
 
#if MIPI_SYST_CONFORMANCE_LEVEL > 10
  mipi_syst_msg_write_t systh_writer;            
#endif
#if defined(MIPI_SYST_PCFG_ENABLE_PLATFORM_STATE_DATA)
  struct mipi_syst_platform_state systh_platform;
#endif
};
 
struct mipi_syst_msg_tag {
#if defined(MIPI_SYST_BIG_ENDIAN)
  mipi_syst_u32 et_res31 : 1;    
  mipi_syst_u32 et_res30 : 1;    
  mipi_syst_u32 et_subtype : 6;  
  mipi_syst_u32 et_guid : 1;     
  mipi_syst_u32 et_modunit : 11; 
  mipi_syst_u32 et_timestamp : 1;
  mipi_syst_u32 et_chksum : 1;   
  mipi_syst_u32 et_length : 1;   
  mipi_syst_u32 et_location : 1; 
  mipi_syst_u32 et_res7 : 1;     
  mipi_syst_u32 et_severity : 3; 
  mipi_syst_u32 et_type : 4;     
#else
  mipi_syst_u32 et_type : 4;     
  mipi_syst_u32 et_severity : 3; 
  mipi_syst_u32 et_res7 : 1;     
  mipi_syst_u32 et_location : 1; 
  mipi_syst_u32 et_length : 1;   
  mipi_syst_u32 et_chksum : 1;   
  mipi_syst_u32 et_timestamp : 1;
  mipi_syst_u32 et_modunit : 11; 
  mipi_syst_u32 et_guid : 1;     
  mipi_syst_u32 et_subtype : 6;  
  mipi_syst_u32 et_res30 : 1;    
  mipi_syst_u32 et_res31 : 1;    
#endif
};
#define _MIPI_SYST_MK_MODUNIT_ORIGIN(m,u) (((u) & 0xF)|(m<<4))
 
enum mipi_syst_severity {
  MIPI_SYST_SEVERITY_MAX = 0,    
  MIPI_SYST_SEVERITY_FATAL = 1,  
  MIPI_SYST_SEVERITY_ERROR = 2,  
  MIPI_SYST_SEVERITY_WARNING = 3,
  MIPI_SYST_SEVERITY_INFO = 4,   
  MIPI_SYST_SEVERITY_USER1 = 5,  
  MIPI_SYST_SEVERITY_USER2 = 6,  
  MIPI_SYST_SEVERITY_DEBUG = 7   
};
 
union mipi_syst_msglocation32 {
  struct {
#if defined(MIPI_SYST_BIG_ENDIAN)
    mipi_syst_u16 etls_lineNo; 
    mipi_syst_u16 etls_fileID; 
#else
    mipi_syst_u16 etls_fileID; 
    mipi_syst_u16 etls_lineNo; 
#endif
  } etls_source_location;
 
  mipi_syst_u32 etls_code_location:32; 
};
 
union mipi_syst_msglocation64 {
  struct {
#if defined(MIPI_SYST_BIG_ENDIAN)
    mipi_syst_u32 etls_lineNo; 
    mipi_syst_u32 etls_fileID; 
#else
    mipi_syst_u32 etls_fileID; 
    mipi_syst_u32 etls_lineNo; 
#endif
  } etls_source_location;
  mipi_syst_u64 etls_code_location; 
};
 
struct mipi_syst_msglocation {
  mipi_syst_u8 el_format;
  union {
    union mipi_syst_msglocation32 loc32; 
    union mipi_syst_msglocation64 loc64; 
  } el_u;
};
 
struct mipi_syst_handle_flags {
  mipi_syst_u32 shf_alloc:1; 
};
 
 struct mipi_syst_handle {
  struct mipi_syst_header* systh_header;     
  struct mipi_syst_handle_flags systh_flags; 
  struct mipi_syst_msg_tag systh_tag;        
#if defined(MIPI_SYST_PCFG_ENABLE_ORIGIN_GUID)
  struct mipi_syst_guid systh_guid;          
#endif
 
#if defined(MIPI_SYST_PCFG_ENABLE_LOCATION_RECORD)
  struct mipi_syst_msglocation systh_location;   
#endif
 
  mipi_syst_u32 systh_param_count;          
  mipi_syst_u32 systh_param[6];             
#if defined(MIPI_SYST_PCFG_ENABLE_PLATFORM_HANDLE_DATA)
  struct mipi_syst_platform_handle systh_platform;
#endif
};
 
 
#ifdef __cplusplus
} /* extern C */
#endif
#ifndef MIPI_SYST_API_INCLUDED
#include "mipi_syst/api.h"
#endif
 
typedef struct mipi_syst_header MIPI_SYST_HEADER;
typedef struct mipi_syst_handle MIPI_SYST_HANDLE;
typedef enum mipi_syst_severity MIPI_SYST_SEVERITY;
typedef struct mipi_syst_guid MIPI_SYST_GUID;
typedef struct mipi_syst_msg_tag MIPI_SYST_MSG_TAG;
typedef struct mipi_syst_handle_flags MIPI_SYST_HANDLE_FLAGS;
#endif