 |
F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
|
F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
C-compatible configuration header for fprime configuration. More...
#include <Fw/Types/BasicTypes.h>Go to the source code of this file.
Macros | |
| #define | PRI_FwIndexType PRI_PlatformIndexType |
| #define | PRI_FwSignedSizeType PRI_PlatformSignedSizeType |
| #define | PRI_FwSizeType PRI_PlatformSizeType |
| #define | PRI_FwAssertArgType PRI_PlatformAssertArgType |
| #define | PRI_FwNativeIntType PRI_PlatformIntType |
| #define | PRI_FwNativeUIntType PRI_PlatformUIntType |
| #define | PRI_FwTaskPriorityType PRI_PlatformTaskPriorityType |
| #define | PRI_FwQueuePriorityType PRI_PlatformQueuePriorityType |
| #define | PRI_FwSizeStoreType PRIu16 |
| #define | PRI_FwEnumStoreType PRId32 |
| #define | FW_CONTEXT_DONT_CARE 0xFF |
| Don't care value for time contexts in sequences. More... | |
| #define | PRI_FwTimeBaseStoreType PRIu16 |
| #define | PRI_FwTimeContextStoreType PRIu8 |
| #define | PRI_FwPacketDescriptorType PRIu32 |
| #define | PRI_FwOpcodeType PRIu32 |
| #define | PRI_FwChanIdType PRIu32 |
| #define | PRI_FwTraceIdType PRIu32 |
| #define | PRI_FwEventIdType PRIu32 |
| #define | PRI_FwPrmIdType PRIu32 |
| #define | PRI_FwTlmPacketizeIdType PRIu16 |
| #define | PRI_FwDpIdType PRIu32 |
| #define | PRI_FwDpPriorityType PRIu32 |
| #define | PRI_FwQueueSizeType PRI_FwIndexType |
| #define | FW_SERIALIZE_TRUE_VALUE (0xFF) |
| Value encoded during serialization for boolean true. More... | |
| #define | FW_SERIALIZE_FALSE_VALUE (0x00) |
| Value encoded during serialization for boolean false. More... | |
| #define | FW_OBJECT_NAMES 1 |
| Indicates whether or not object names are stored (more memory, can be used for tracking objects) More... | |
| #define | FW_OPTIONAL_NAME(name) name |
| #define | FW_OBJECT_TO_STRING 1 |
| Indicates whether or not generated objects have toString() methods to dump internals (more code) More... | |
| #define | FW_OBJECT_REGISTRATION 1 |
| Indicates whether or not objects can register themselves (more code, more object tracking) More... | |
| #define | FW_QUEUE_REGISTRATION 1 |
| Indicates whether or not queue registration is used. More... | |
| #define | FW_BAREMETAL_SCHEDULER 0 |
| Indicates whether or not a baremetal scheduler should be used. Alternatively the Os scheduler is used. More... | |
| #define | FW_USE_PRINTF_FAMILY_FUNCTIONS_IN_STRING_FORMATTING 1 |
| #define | FW_PORT_TRACING 1 |
| Indicates whether port calls are traced (more code, more visibility into execution) More... | |
| #define | FW_PORT_SERIALIZATION 1 |
| for multi-note systems) More... | |
| #define | FW_SERIALIZATION_TYPE_ID 0 |
| Indicates if type id is stored when type is serialized. (More storage, but more type safety) More... | |
| #define | FW_ASSERT_LEVEL FW_FILENAME_ASSERT |
| Defines the type of assert used. More... | |
| #define | FW_OBJ_NAME_BUFFER_SIZE 80 |
| Size of object name (if object names enabled). AC Limits to 80, truncation occurs above 80. More... | |
| #define | FW_OBJ_SIMPLE_REG_ENTRIES 500 |
| Number of objects stored in simple object registry. More... | |
| #define | FW_OBJ_SIMPLE_REG_BUFF_SIZE 255 |
| Size of object registry dump string. More... | |
| #define | FW_QUEUE_SIMPLE_QUEUE_ENTRIES 100 |
| Number of queues stored in simple queue registry. More... | |
| #define | FW_QUEUE_NAME_BUFFER_SIZE 80 |
| Max size of message queue name. More... | |
| #define | FW_TASK_NAME_BUFFER_SIZE 80 |
| Max size of task name. More... | |
| #define | FW_COM_BUFFER_MAX_SIZE 512 |
| #define | FW_SM_SIGNAL_BUFFER_MAX_SIZE 128 |
| #define | FW_CMD_ARG_BUFFER_MAX_SIZE (FW_COM_BUFFER_MAX_SIZE - sizeof(FwOpcodeType) - sizeof(FwPacketDescriptorType)) |
| #define | FW_CMD_STRING_MAX_SIZE 40 |
| Max character size of command string arguments. More... | |
| #define | FW_CMD_CHECK_RESIDUAL 1 |
| Check for leftover command bytes. More... | |
| #define | FW_LOG_BUFFER_MAX_SIZE (FW_COM_BUFFER_MAX_SIZE - sizeof(FwEventIdType) - sizeof(FwPacketDescriptorType)) |
| #define | FW_LOG_STRING_MAX_SIZE 200 |
| Max size of log string parameter type. More... | |
| #define | FW_TLM_BUFFER_MAX_SIZE (FW_COM_BUFFER_MAX_SIZE - sizeof(FwChanIdType) - sizeof(FwPacketDescriptorType)) |
| #define | FW_TLM_STRING_MAX_SIZE 40 |
| Max size of channelized telemetry string type. More... | |
| #define | FW_PARAM_BUFFER_MAX_SIZE (FW_COM_BUFFER_MAX_SIZE - sizeof(FwPrmIdType) - sizeof(FwPacketDescriptorType)) |
| #define | FW_PARAM_STRING_MAX_SIZE 40 |
| Max size of parameter string type. More... | |
| #define | FW_FILE_BUFFER_MAX_SIZE 255 |
| Max size of file buffer (i.e. chunk of file) More... | |
| #define | FW_INTERNAL_INTERFACE_STRING_MAX_SIZE 256 |
| Max size of interface string parameter type. More... | |
| #define | FW_ENABLE_TEXT_LOGGING 1 |
| Indicates whether text logging is turned on. More... | |
| #define | FW_LOG_TEXT_BUFFER_SIZE 256 |
| Max size of string for text log message. More... | |
| #define | FW_SERIALIZABLE_TO_STRING 1 |
| Indicates if autocoded serializables have toString() methods. More... | |
| #define | FW_AMPCS_COMPATIBLE 0 |
| Whether or not JPL AMPCS ground system support is enabled. More... | |
| #define | FW_USE_TIME_BASE 1 |
| Whether or not to use the time base. More... | |
| #define | FW_USE_TIME_CONTEXT 1 |
| Whether or not to serialize the time context. More... | |
| #define | FW_FIXED_LENGTH_STRING_SIZE 256 |
| Character array size for Fw::String. More... | |
| #define | FW_CONSOLE_HANDLE_MAX_SIZE 24 |
| Maximum size of a handle for OS queues. More... | |
| #define | FW_TASK_HANDLE_MAX_SIZE 24 |
| Maximum size of a handle for OS queues. More... | |
| #define | FW_FILE_HANDLE_MAX_SIZE 16 |
| Maximum size of a handle for OS queues. More... | |
| #define | FW_MUTEX_HANDLE_MAX_SIZE 72 |
| Maximum size of a handle for OS queues. More... | |
| #define | FW_QUEUE_HANDLE_MAX_SIZE 352 |
| Maximum size of a handle for OS queues. More... | |
| #define | FW_DIRECTORY_HANDLE_MAX_SIZE 16 |
| Maximum size of a handle for OS resources (files, queues, locks, etc.) More... | |
| #define | FW_FILESYSTEM_HANDLE_MAX_SIZE 16 |
| Maximum size of a handle for OS resources (files, queues, locks, etc.) More... | |
| #define | FW_RAW_TIME_HANDLE_MAX_SIZE 24 |
| Maximum size of a handle for OS::RawTime objects. More... | |
| #define | FW_RAW_TIME_SERIALIZATION_MAX_SIZE 8 |
| Maximum allowed serialization size for Os::RawTime objects. More... | |
| #define | FW_CONDITION_VARIABLE_HANDLE_MAX_SIZE 56 |
| Maximum size of a handle for OS condition variables. More... | |
| #define | FW_CPU_HANDLE_MAX_SIZE 16 |
| Maximum size of a handle for OS cpu. More... | |
| #define | FW_MEMORY_HANDLE_MAX_SIZE 16 |
| Maximum size of a handle for OS memory. More... | |
| #define | FW_HANDLE_ALIGNMENT 8 |
| Alignment of handle storage. More... | |
| #define | FW_FILE_CHUNK_SIZE 512 |
| Chunk size for working with files in the OSAL layer. More... | |
| #define | PRI_FwBuffSizeType PRI_FwSizeStoreType |
Typedefs | |
| typedef PlatformIndexType | FwIndexType |
| typedef PlatformSignedSizeType | FwSignedSizeType |
| typedef PlatformSizeType | FwSizeType |
| typedef PlatformAssertArgType | FwAssertArgType |
| typedef PlatformIntType | FwNativeIntType |
| typedef PlatformUIntType | FwNativeUIntType |
| typedef PlatformTaskPriorityType | FwTaskPriorityType |
| typedef PlatformQueuePriorityType | FwQueuePriorityType |
| typedef U16 | FwSizeStoreType |
| typedef I32 | FwEnumStoreType |
| typedef U16 | FwTimeBaseStoreType |
| typedef U8 | FwTimeContextStoreType |
| typedef U32 | FwPacketDescriptorType |
| typedef U32 | FwOpcodeType |
| typedef U32 | FwChanIdType |
| typedef U32 | FwTraceIdType |
| typedef U32 | FwEventIdType |
| typedef U32 | FwPrmIdType |
| typedef U16 | FwTlmPacketizeIdType |
| typedef U32 | FwDpIdType |
| typedef U32 | FwDpPriorityType |
| typedef FwIndexType | FwQueueSizeType |
| typedef FwSizeStoreType | FwBuffSizeType |
Enumerations | |
| enum | TimeBase { TB_NONE , TB_PROC_TIME , TB_WORKSTATION_TIME , TB_DONT_CARE } |
C-compatible configuration header for fprime configuration.
Definition in file FpConfig.h.
| #define FW_AMPCS_COMPATIBLE 0 |
Whether or not JPL AMPCS ground system support is enabled.
Definition at line 370 of file FpConfig.h.
| #define FW_ASSERT_LEVEL FW_FILENAME_ASSERT |
Defines the type of assert used.
Definition at line 238 of file FpConfig.h.
| #define FW_BAREMETAL_SCHEDULER 0 |
Indicates whether or not a baremetal scheduler should be used. Alternatively the Os scheduler is used.
Definition at line 184 of file FpConfig.h.
| #define FW_CMD_ARG_BUFFER_MAX_SIZE (FW_COM_BUFFER_MAX_SIZE - sizeof(FwOpcodeType) - sizeof(FwPacketDescriptorType)) |
Definition at line 293 of file FpConfig.h.
| #define FW_CMD_CHECK_RESIDUAL 1 |
Check for leftover command bytes.
Definition at line 308 of file FpConfig.h.
| #define FW_CMD_STRING_MAX_SIZE 40 |
Max character size of command string arguments.
Definition at line 298 of file FpConfig.h.
| #define FW_COM_BUFFER_MAX_SIZE 512 |
Definition at line 282 of file FpConfig.h.
| #define FW_CONDITION_VARIABLE_HANDLE_MAX_SIZE 56 |
Maximum size of a handle for OS condition variables.
Definition at line 428 of file FpConfig.h.
| #define FW_CONSOLE_HANDLE_MAX_SIZE 24 |
Maximum size of a handle for OS queues.
Definition at line 392 of file FpConfig.h.
| #define FW_CONTEXT_DONT_CARE 0xFF |
Don't care value for time contexts in sequences.
Definition at line 76 of file FpConfig.h.
| #define FW_CPU_HANDLE_MAX_SIZE 16 |
Maximum size of a handle for OS cpu.
Definition at line 432 of file FpConfig.h.
| #define FW_DIRECTORY_HANDLE_MAX_SIZE 16 |
Maximum size of a handle for OS resources (files, queues, locks, etc.)
Definition at line 412 of file FpConfig.h.
| #define FW_ENABLE_TEXT_LOGGING 1 |
Indicates whether text logging is turned on.
Definition at line 354 of file FpConfig.h.
| #define FW_FILE_BUFFER_MAX_SIZE 255 |
Max size of file buffer (i.e. chunk of file)
Definition at line 344 of file FpConfig.h.
| #define FW_FILE_CHUNK_SIZE 512 |
Chunk size for working with files in the OSAL layer.
Definition at line 445 of file FpConfig.h.
| #define FW_FILE_HANDLE_MAX_SIZE 16 |
Maximum size of a handle for OS queues.
Definition at line 400 of file FpConfig.h.
| #define FW_FILESYSTEM_HANDLE_MAX_SIZE 16 |
Maximum size of a handle for OS resources (files, queues, locks, etc.)
Definition at line 416 of file FpConfig.h.
| #define FW_FIXED_LENGTH_STRING_SIZE 256 |
Character array size for Fw::String.
Definition at line 387 of file FpConfig.h.
| #define FW_HANDLE_ALIGNMENT 8 |
Alignment of handle storage.
Definition at line 440 of file FpConfig.h.
| #define FW_INTERNAL_INTERFACE_STRING_MAX_SIZE 256 |
Max size of interface string parameter type.
Definition at line 349 of file FpConfig.h.
| #define FW_LOG_BUFFER_MAX_SIZE (FW_COM_BUFFER_MAX_SIZE - sizeof(FwEventIdType) - sizeof(FwPacketDescriptorType)) |
Definition at line 313 of file FpConfig.h.
| #define FW_LOG_STRING_MAX_SIZE 200 |
Max size of log string parameter type.
Definition at line 319 of file FpConfig.h.
| #define FW_LOG_TEXT_BUFFER_SIZE 256 |
Max size of string for text log message.
Definition at line 359 of file FpConfig.h.
| #define FW_MEMORY_HANDLE_MAX_SIZE 16 |
Maximum size of a handle for OS memory.
Definition at line 436 of file FpConfig.h.
| #define FW_MUTEX_HANDLE_MAX_SIZE 72 |
Maximum size of a handle for OS queues.
Definition at line 404 of file FpConfig.h.
| #define FW_OBJ_NAME_BUFFER_SIZE 80 |
Size of object name (if object names enabled). AC Limits to 80, truncation occurs above 80.
Definition at line 247 of file FpConfig.h.
| #define FW_OBJ_SIMPLE_REG_BUFF_SIZE 255 |
Size of object registry dump string.
Definition at line 259 of file FpConfig.h.
| #define FW_OBJ_SIMPLE_REG_ENTRIES 500 |
Number of objects stored in simple object registry.
Definition at line 254 of file FpConfig.h.
| #define FW_OBJECT_NAMES 1 |
Indicates whether or not object names are stored (more memory, can be used for tracking objects)
Definition at line 149 of file FpConfig.h.
| #define FW_OBJECT_REGISTRATION 1 |
Indicates whether or not objects can register themselves (more code, more object tracking)
Definition at line 175 of file FpConfig.h.
| #define FW_OBJECT_TO_STRING 1 |
Indicates whether or not generated objects have toString() methods to dump internals (more code)
Definition at line 165 of file FpConfig.h.
| #define FW_OPTIONAL_NAME | ( | name | ) | name |
Definition at line 155 of file FpConfig.h.
| #define FW_PARAM_BUFFER_MAX_SIZE (FW_COM_BUFFER_MAX_SIZE - sizeof(FwPrmIdType) - sizeof(FwPacketDescriptorType)) |
Definition at line 334 of file FpConfig.h.
| #define FW_PARAM_STRING_MAX_SIZE 40 |
Max size of parameter string type.
Definition at line 339 of file FpConfig.h.
| #define FW_PORT_SERIALIZATION 1 |
for multi-note systems)
Indicates whether there is code in ports to serialize the call (more code, but ability to serialize calls
Definition at line 206 of file FpConfig.h.
| #define FW_PORT_TRACING 1 |
Indicates whether port calls are traced (more code, more visibility into execution)
Definition at line 199 of file FpConfig.h.
| #define FW_QUEUE_HANDLE_MAX_SIZE 352 |
Maximum size of a handle for OS queues.
Definition at line 408 of file FpConfig.h.
| #define FW_QUEUE_NAME_BUFFER_SIZE 80 |
Max size of message queue name.
Definition at line 272 of file FpConfig.h.
| #define FW_QUEUE_REGISTRATION 1 |
Indicates whether or not queue registration is used.
Definition at line 179 of file FpConfig.h.
| #define FW_QUEUE_SIMPLE_QUEUE_ENTRIES 100 |
Number of queues stored in simple queue registry.
Definition at line 266 of file FpConfig.h.
| #define FW_RAW_TIME_HANDLE_MAX_SIZE 24 |
Maximum size of a handle for OS::RawTime objects.
Definition at line 420 of file FpConfig.h.
| #define FW_RAW_TIME_SERIALIZATION_MAX_SIZE 8 |
Maximum allowed serialization size for Os::RawTime objects.
Definition at line 424 of file FpConfig.h.
| #define FW_SERIALIZABLE_TO_STRING 1 |
Indicates if autocoded serializables have toString() methods.
Definition at line 365 of file FpConfig.h.
| #define FW_SERIALIZATION_TYPE_ID 0 |
Indicates if type id is stored when type is serialized. (More storage, but more type safety)
Definition at line 219 of file FpConfig.h.
| #define FW_SERIALIZE_FALSE_VALUE (0x00) |
Value encoded during serialization for boolean false.
Definition at line 143 of file FpConfig.h.
| #define FW_SERIALIZE_TRUE_VALUE (0xFF) |
Value encoded during serialization for boolean true.
Definition at line 139 of file FpConfig.h.
| #define FW_SM_SIGNAL_BUFFER_MAX_SIZE 128 |
Definition at line 287 of file FpConfig.h.
| #define FW_TASK_HANDLE_MAX_SIZE 24 |
Maximum size of a handle for OS queues.
Definition at line 396 of file FpConfig.h.
| #define FW_TASK_NAME_BUFFER_SIZE 80 |
Max size of task name.
Definition at line 277 of file FpConfig.h.
| #define FW_TLM_BUFFER_MAX_SIZE (FW_COM_BUFFER_MAX_SIZE - sizeof(FwChanIdType) - sizeof(FwPacketDescriptorType)) |
Definition at line 324 of file FpConfig.h.
| #define FW_TLM_STRING_MAX_SIZE 40 |
Max size of channelized telemetry string type.
Definition at line 329 of file FpConfig.h.
| #define FW_USE_PRINTF_FAMILY_FUNCTIONS_IN_STRING_FORMATTING 1 |
Definition at line 192 of file FpConfig.h.
| #define FW_USE_TIME_BASE 1 |
Whether or not to use the time base.
Definition at line 377 of file FpConfig.h.
| #define FW_USE_TIME_CONTEXT 1 |
Whether or not to serialize the time context.
Definition at line 381 of file FpConfig.h.
| #define PRI_FwAssertArgType PRI_PlatformAssertArgType |
Definition at line 40 of file FpConfig.h.
| #define PRI_FwBuffSizeType PRI_FwSizeStoreType |
Definition at line 453 of file FpConfig.h.
| #define PRI_FwChanIdType PRIu32 |
Definition at line 96 of file FpConfig.h.
| #define PRI_FwDpIdType PRIu32 |
Definition at line 116 of file FpConfig.h.
| #define PRI_FwDpPriorityType PRIu32 |
Definition at line 120 of file FpConfig.h.
| #define PRI_FwEnumStoreType PRId32 |
Definition at line 65 of file FpConfig.h.
| #define PRI_FwEventIdType PRIu32 |
Definition at line 104 of file FpConfig.h.
| #define PRI_FwIndexType PRI_PlatformIndexType |
Definition at line 26 of file FpConfig.h.
| #define PRI_FwNativeIntType PRI_PlatformIntType |
Definition at line 44 of file FpConfig.h.
| #define PRI_FwNativeUIntType PRI_PlatformUIntType |
Definition at line 48 of file FpConfig.h.
| #define PRI_FwOpcodeType PRIu32 |
Definition at line 92 of file FpConfig.h.
| #define PRI_FwPacketDescriptorType PRIu32 |
Definition at line 88 of file FpConfig.h.
| #define PRI_FwPrmIdType PRIu32 |
Definition at line 108 of file FpConfig.h.
| #define PRI_FwQueuePriorityType PRI_PlatformQueuePriorityType |
Definition at line 56 of file FpConfig.h.
| #define PRI_FwQueueSizeType PRI_FwIndexType |
Definition at line 131 of file FpConfig.h.
| #define PRI_FwSignedSizeType PRI_PlatformSignedSizeType |
Definition at line 31 of file FpConfig.h.
| #define PRI_FwSizeStoreType PRIu16 |
Definition at line 60 of file FpConfig.h.
| #define PRI_FwSizeType PRI_PlatformSizeType |
Definition at line 36 of file FpConfig.h.
| #define PRI_FwTaskPriorityType PRI_PlatformTaskPriorityType |
Definition at line 52 of file FpConfig.h.
| #define PRI_FwTimeBaseStoreType PRIu16 |
Definition at line 80 of file FpConfig.h.
| #define PRI_FwTimeContextStoreType PRIu8 |
Definition at line 84 of file FpConfig.h.
| #define PRI_FwTlmPacketizeIdType PRIu16 |
Definition at line 112 of file FpConfig.h.
| #define PRI_FwTraceIdType PRIu32 |
Definition at line 100 of file FpConfig.h.
| typedef PlatformAssertArgType FwAssertArgType |
Definition at line 39 of file FpConfig.h.
| typedef FwSizeStoreType FwBuffSizeType |
Definition at line 452 of file FpConfig.h.
| typedef U32 FwChanIdType |
Definition at line 95 of file FpConfig.h.
| typedef U32 FwDpIdType |
Definition at line 115 of file FpConfig.h.
| typedef U32 FwDpPriorityType |
Definition at line 119 of file FpConfig.h.
| typedef I32 FwEnumStoreType |
Definition at line 64 of file FpConfig.h.
| typedef U32 FwEventIdType |
Definition at line 103 of file FpConfig.h.
| typedef PlatformIndexType FwIndexType |
Definition at line 25 of file FpConfig.h.
| typedef PlatformIntType FwNativeIntType |
Definition at line 43 of file FpConfig.h.
| typedef PlatformUIntType FwNativeUIntType |
Definition at line 47 of file FpConfig.h.
| typedef U32 FwOpcodeType |
Definition at line 91 of file FpConfig.h.
| typedef U32 FwPacketDescriptorType |
Definition at line 87 of file FpConfig.h.
| typedef U32 FwPrmIdType |
Definition at line 107 of file FpConfig.h.
| typedef PlatformQueuePriorityType FwQueuePriorityType |
Definition at line 55 of file FpConfig.h.
| typedef FwIndexType FwQueueSizeType |
Definition at line 130 of file FpConfig.h.
| typedef PlatformSignedSizeType FwSignedSizeType |
Definition at line 30 of file FpConfig.h.
| typedef U16 FwSizeStoreType |
Definition at line 59 of file FpConfig.h.
| typedef PlatformSizeType FwSizeType |
Definition at line 35 of file FpConfig.h.
| typedef PlatformTaskPriorityType FwTaskPriorityType |
Definition at line 51 of file FpConfig.h.
| typedef U16 FwTimeBaseStoreType |
Definition at line 79 of file FpConfig.h.
| typedef U8 FwTimeContextStoreType |
Definition at line 83 of file FpConfig.h.
| typedef U16 FwTlmPacketizeIdType |
Definition at line 111 of file FpConfig.h.
| typedef U32 FwTraceIdType |
Definition at line 99 of file FpConfig.h.
| enum TimeBase |
Definition at line 69 of file FpConfig.h.
1.9.1