-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add fmi-ls-bus headers (utility headers)
- Loading branch information
Benedikt Menne
authored and
Benedikt Menne
committed
Sep 20, 2023
1 parent
3a676c1
commit 54908d9
Showing
2 changed files
with
711 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,163 @@ | ||
#ifndef fmi3LsBusUtil_h | ||
#define fmi3LsBusUtil_h | ||
|
||
/* | ||
This header file contains utility macros to read and write fmi-ls-bus | ||
bus operations from\to dedicated buffer variables. | ||
This header can be used when creating Network FMUs. | ||
Copyright (C) 2008-2011 MODELISAR consortium, | ||
2012-2023 Modelica Association Project "FMI" | ||
All rights reserved. | ||
This file is licensed by the copyright holders under the 2-Clause BSD License | ||
(https://opensource.org/licenses/BSD-2-Clause): | ||
---------------------------------------------------------------------------- | ||
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. | ||
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 HOLDER 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. | ||
---------------------------------------------------------------------------- | ||
*/ | ||
|
||
#include "fmi3LsBus.h" | ||
#include <string.h> | ||
|
||
#ifdef __cplusplus | ||
extern "C" | ||
{ | ||
#endif | ||
|
||
/** | ||
* This data type holds information to read and write bus operations to\from | ||
* a buffer variable via utility maros such as \ref FMI3_LS_BUS_BUFFER_WRITE and | ||
* \ref FMI3_LS_BUS_READ_NEXT_OPERATION. Variables of this type should be initialized | ||
* by \ref FMI3_LS_BUS_BUFFER_INFO_INIT and resetted by \ref FMI3_LS_BUS_BUFFER_INFO_RESET. | ||
*/ | ||
typedef struct | ||
{ | ||
fmi3UInt8* start; /**< The start address of the buffer variable. */ | ||
size_t size; /**< The size of the buffer variable. */ | ||
fmi3UInt8* end; /**< The end address of the buffer variable. */ | ||
fmi3UInt8* writePos; /**< The current write position. */ | ||
fmi3UInt8* readPos; /**< The current read position. */ | ||
fmi3Boolean status; /**< Holds the status (fmi3True\fmi3False) of the last macro call. */ | ||
} fmi3LsBusUtilBufferInfo; | ||
|
||
|
||
/** | ||
* \brief Initializes a variable of type \ref fmi3LsBusUtilBufferInfo | ||
* | ||
* This macro should be used to initialize variables of type \ref fmi3LsBusUtilBufferInfo. | ||
* | ||
* Example: | ||
* fmi3UInt8 buffer[2048]; | ||
* fmi3LsBusUtilBufferInfo bufferInfo; | ||
* FMI3_LS_BUS_BUFFER_INFO_INIT(&bufferInfo, buffer, sizeof(buffer)); | ||
* | ||
* \param[in] Pointer to variable of type \ref fmi3LsBusUtilBufferInfo. | ||
* \param[in] Pointer to buffer variable. | ||
* \param[in] Size of the buffer variable. | ||
*/ | ||
#define FMI3_LS_BUS_BUFFER_INFO_INIT(BufferInfo, Buffer, Size) \ | ||
do \ | ||
{ \ | ||
(BufferInfo)->start = (Buffer); \ | ||
(BufferInfo)->size = (Size); \ | ||
(BufferInfo)->end = (Buffer) + (Size); \ | ||
(BufferInfo)->writePos = (BufferInfo)->start; \ | ||
(BufferInfo)->readPos = (BufferInfo)->start; \ | ||
(BufferInfo)->status = fmi3True; \ | ||
} \ | ||
while (0) | ||
|
||
/** | ||
* \brief Resets a variable of type \ref fmi3LsBusUtilBufferInfo | ||
* | ||
* This macro should be used to reset variables of type \ref fmi3LsBusUtilBufferInfo. | ||
* Read and write positions are set to the buffer start address. | ||
* The Variable must be initialize via ref FMI3_LS_BUS_BUFFER_INFO_INIT before | ||
* | ||
* | ||
* \param Pointer to variable of type \ref fmi3LsBusUtilBufferInfo. | ||
*/ | ||
#define FMI3_LS_BUS_BUFFER_INFO_RESET(BufferInfo) \ | ||
do \ | ||
{ \ | ||
(BufferInfo)->writePos = (BufferInfo)->start; \ | ||
(BufferInfo)->readPos = (BufferInfo)->start; \ | ||
(BufferInfo)->status = fmi3True; \ | ||
} \ | ||
while (0) | ||
|
||
/** | ||
* \brief Writes data to a buffer variable. Existing data will be overwitten. | ||
* | ||
* \param Pointer to variable of type \ref fmi3LsBusUtilBufferInfo. | ||
* \param Pointer to buffer variable. | ||
* \param Size of the buffer variable. | ||
*/ | ||
#define FMI3_LS_BUS_BUFFER_WRITE(BufferInfo, data, dataLength) \ | ||
do \ | ||
{ \ | ||
if ((dataLength) <= (BufferInfo)->size) \ | ||
{ \ | ||
memcpy((bufferInfo)->start, (data), (dataLength)); \ | ||
(bufferInfo)->writePos = (bufferInfo)->start + (dataLength); \ | ||
(bufferInfo)->readPos = (bufferInfo)->start; \ | ||
(bufferInfo)->status = fmi3True; \ | ||
} \ | ||
else \ | ||
{ \ | ||
(bufferInfo)->status = fmi3False; \ | ||
} \ | ||
} \ | ||
while (0) | ||
|
||
/** | ||
* \brief Reads next bus operation from buffer. | ||
* | ||
* Example: | ||
* fmi3LsBusOperationHeader* nextOperation; | ||
* while(FMI3_LS_BUS_READ_NEXT_OPERATION(BufferInfo,nextOperation)) | ||
* { | ||
* ... | ||
* } | ||
* | ||
* \param[in] Pointer to variable of type \ref fmi3LsBusUtilBufferInfo. | ||
* \param[out] Pointer of type \ref fmi3LsBusOperationHeader* set by the macro | ||
* to the address where the next bus operation can be read from. | ||
* \return fmi3True if a new operation is available else fmi3False. | ||
*/ | ||
#define FMI3_LS_BUS_READ_NEXT_OPERATION(BufferInfo, Operation) \ | ||
(((BufferInfo)->writePos - (BufferInfo)->readPos) > sizeof(fmi3LsBusOperationHeader) && \ | ||
((BufferInfo)->writePos - (BufferInfo)->readPos) >= ((fmi3LsBusOperationHeader*)(BufferInfo)->readPos)->length) \ | ||
? (Operation = (fmi3LsBusOperationHeader*)(BufferInfo)->readPos, (BufferInfo)->readPos += Operation->length), \ | ||
fmi3True : fmi3False\ | ||
|
||
|
||
#ifdef __cplusplus | ||
} /* end of extern "C" { */ | ||
#endif | ||
|
||
#endif /* fmi3LsBusUtil_h */ |
Oops, something went wrong.