Macros | Functions
sbgPlatform.h File Reference

Header file that contains all platform specific definitions. More...

#include <stdint.h>
#include "sbgDefines.h"
#include "sbgDebug.h"
#include "sbgErrorCodes.h"
Include dependency graph for sbgPlatform.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define SBG_PLATFORM_ASSERT(expression)   assert((expression))
 

Functions

SBG_COMMON_LIB_API uint32_t sbgGetTime (void)
 
SBG_COMMON_LIB_API void sbgPlatformDebugLogMsg (const char *pFileName, const char *pFunctionName, uint32_t line, const char *pCategory, SbgDebugLogType logType, SbgErrorCode errorCode, const char *pFormat,...)
 
SBG_COMMON_LIB_API void sbgSleep (uint32_t ms)
 

Detailed Description

Header file that contains all platform specific definitions.

Author
SBG Systems (Raphael Siryani)
Date
17 March 2015

This file should be modified to each targeted platform. For example, all common headers should be included from this file.

The platform endianness should be defined here.

Copyright Notice

Copyright (C) 2007-2013, SBG Systems SAS. All rights reserved.

This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.

THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.

Definition in file sbgPlatform.h.

Macro Definition Documentation

◆ SBG_PLATFORM_ASSERT

#define SBG_PLATFORM_ASSERT (   expression)    assert((expression))

Run time assert that is raised if the expression is false.

Parameters
[in]expressionThe boolean expression to test, the execution is interrupted if the expression is evaluated as false.

Definition at line 87 of file sbgPlatform.h.

Function Documentation

◆ sbgGetTime()

SBG_COMMON_LIB_API uint32_t sbgGetTime ( void  )

Returns the current time in ms.

Returns
The current time in ms.

Definition at line 24 of file sbgPlatform.c.

◆ sbgPlatformDebugLogMsg()

SBG_COMMON_LIB_API void sbgPlatformDebugLogMsg ( const char *  pFileName,
const char *  pFunctionName,
uint32_t  line,
const char *  pCategory,
SbgDebugLogType  logType,
SbgErrorCode  errorCode,
const char *  pFormat,
  ... 
)

The method is called when one of the SBG_LOG_ERROR, SBG_LOG_WARNING, SBG_LOG_INFO or SBG_LOG_VERBOSE is called. It logs an error message with debug information and support a variable list of arguments

Parameters
[in]pFileNameFile name where the error occurred.
[in]pFunctionNameFunction name where the error occurred.
[in]lineLine number where the error occurred.
[in]pCategoryCategory for this log or "None" if no category has been specified.
[in]logTypeDefine if we have an error, a warning, an info or a debug log.
[in]errorCodeThe error code associated with the message.
[in]pFormatThe error message that will be used with the variable list of arguments.

The method is called when one of the SBG_LOG_ERROR, SBG_LOG_WARNING, SBG_LOG_INFO or SBG_LOG_VERBOSE is called. It logs an error message with debug information and support a variable list of arguments

Parameters
[in]pFileNameFile name where the error occurred.
[in]pFunctionNameFunction name where the error occurred.
[in]lineLine number where the error occurred.
[in]logTypeDefine if we have an error, a warning, an info or a verbose log.
[in]errorCodeThe error code associated with the message.
[in]pFormatThe error message that will be used with the variable list of arguments.

Definition at line 80 of file sbgPlatform.c.

◆ sbgSleep()

SBG_COMMON_LIB_API void sbgSleep ( uint32_t  ms)

Sleep for the specified number of ms.

Parameters
[in]msNumber of millisecondes to wait.

Definition at line 54 of file sbgPlatform.c.



sbg_driver
Author(s): SBG Systems
autogenerated on Sat Sep 3 2022 02:53:36