F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
FppConstantsAc.hpp File Reference

Go to the source code of this file.

Namespaces

 Drv
 
 Drv::AsyncI2cCfg
 
 ComCfg
 
 Fw
 Implementation of malloc based allocator.
 
 Fw::DpCfg
 
 Svc
 RateGroupDivider component implementation.
 
 Svc::FileDispatcherCfg
 
 Svc::Fpy
 
 Svc::GenericHubCfg
 
 Os
 

Enumerations

enum  { ActiveRateGroupOutputPorts = 10 }
 Number of rate group member output ports for ActiveRateGroup. More...
 
enum  { PassiveRateGroupOutputPorts = 10 }
 Number of rate group member output ports for PassiveRateGroup. More...
 
enum  { RateGroupDriverRateGroupPorts = 3 }
 Used to drive rate groups. More...
 
enum  { CmdDispatcherComponentCommandPorts = 30 }
 Used for command and registration ports. More...
 
enum  { CmdDispatcherSequencePorts = 5 }
 Used for uplink/sequencer buffer/response ports. More...
 
enum  { SeqDispatcherSequencerPorts = 2 }
 Used for dispatching sequences to command sequencers. More...
 
enum  { CmdSplitterPorts = 5 }
 Used for sizing the command splitter input arrays. More...
 
enum  { StaticMemoryAllocations = 4 }
 Number of static memory allocations. More...
 
enum  { HealthPingPorts = 25 }
 Used to ping active components. More...
 
enum  { FileDownCompletePorts = 1 }
 Used for broadcasting completed file downlinks. More...
 
enum  { ComQueueComPorts = 2 }
 Used for number of Fw::Com type ports supported by Svc::ComQueue. More...
 
enum  { ComQueueBufferPorts = 1 }
 Used for number of Fw::Buffer type ports supported by Svc::ComQueue. More...
 
enum  { BufferRepeaterOutputPorts = 10 }
 Used for maximum number of connected buffer repeater consumers. More...
 
enum  { DpManagerNumPorts = 5 }
 Size of port array for DpManager. More...
 
enum  { DpWriterNumProcPorts = 5 }
 Size of processing port array for DpWriter. More...
 
enum  { FileNameStringSize = 240 }
 The size of a file name string. More...
 
enum  { FwAssertTextSize = 256 }
 The size of an assert text string. More...
 
enum  { AssertFatalAdapterEventFileSize = 240 }
 
enum  { SequenceArgumentsMaxSize = 255 }
 
enum  { Drv::AsyncI2cCfg::I2cDriverPorts = 10 }
 
enum  { ComCfg::SpacecraftId = 68 }
 Spacecraft ID (10 bits) for CCSDS Data Link layer. More...
 
enum  { ComCfg::TmFrameFixedSize = 1024 }
 Fixed size of CCSDS TM frames. More...
 
enum  { ComCfg::AosMaxFrameFixedSize = 1536 }
 Upper Bound on Fixed size of CCSDS AOS frames. More...
 
enum  { ComCfg::AggregationSize = 1009 }
 Aggregation buffer for ComAggregator component. More...
 
enum  { Fw::DpCfg::CONTAINER_USER_DATA_SIZE = 32 }
 
enum  { Svc::FileDispatcherCfg::FILE_DISPATCHER_MAX_TABLE_SIZE = 10 }
 
enum  { FW_OBJ_SIMPLE_REG_BUFF_SIZE = 255 }
 
enum  { FW_QUEUE_NAME_BUFFER_SIZE = 80 }
 Specifies the size of the string holding the queue name for queues. More...
 
enum  { FW_TASK_NAME_BUFFER_SIZE = 80 }
 Specifies the size of the string holding the task name for active components and tasks. More...
 
enum  { FW_COM_BUFFER_MAX_SIZE = 512 }
 Specifies the size of the buffer that contains a communications packet. More...
 
enum  { FW_SM_SIGNAL_BUFFER_MAX_SIZE = 128 }
 Specifies the size of the buffer attached to state machine signals. More...
 
enum  { FW_CMD_ARG_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized command arguments. More...
 
enum  { FW_CMD_STRING_MAX_SIZE = 40 }
 Specifies the maximum size of a string in a command argument. More...
 
enum  { FW_LOG_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized log arguments. More...
 
enum  { FW_LOG_STRING_MAX_SIZE = 200 }
 
enum  { FW_TLM_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized telemetry value. More...
 
enum  { FW_STATEMENT_ARG_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized telemetry value. More...
 
enum  { FW_TLM_STRING_MAX_SIZE = 40 }
 Specifies the maximum size of a string in a telemetry channel. More...
 
enum  { FW_PARAM_BUFFER_MAX_SIZE = 506 }
 Specifies the size of the buffer that contains the serialized parameter value. More...
 
enum  { FW_PARAM_STRING_MAX_SIZE = 40 }
 Specifies the maximum size of a string in a parameter. More...
 
enum  { FW_FILE_BUFFER_MAX_SIZE = 512 }
 Specifies the maximum size of a file downlink chunk. More...
 
enum  { FW_INTERNAL_INTERFACE_STRING_MAX_SIZE = 256 }
 Specifies the maximum size of a string in an interface call. More...
 
enum  { FW_LOG_TEXT_BUFFER_SIZE = 256 }
 Defines the size of the text log string buffer. Should be large enough for format string and arguments. More...
 
enum  { FW_FIXED_LENGTH_STRING_SIZE = 256 }
 
enum  { FW_OBJ_SIMPLE_REG_ENTRIES = 500 }
 For the simple object registry provided with the framework, this specifies how many objects the registry will store. More...
 
enum  { FW_QUEUE_SIMPLE_QUEUE_ENTRIES = 100 }
 For the simple queue registry provided with the framework, this specifies how many queues the registry will store. More...
 
enum  { FW_ASSERT_COUNT_MAX = 10 }
 Maximum number of cascading FW_ASSERT check failures before forcing a system assert. More...
 
enum  { FW_CONTEXT_DONT_CARE = 255 }
 Don't care value for time contexts in sequences. More...
 
enum  { FW_SERIALIZE_TRUE_VALUE = 255 }
 Value encoded during serialization for boolean true. More...
 
enum  { FW_SERIALIZE_FALSE_VALUE = 0 }
 Value encoded during serialization for boolean false. More...
 
enum  { Svc::Fpy::MAX_SEQUENCE_ARG_COUNT = 16 }
 The maximum number of arguments a sequence can have. More...
 
enum  { Svc::Fpy::MAX_SEQUENCE_STATEMENT_COUNT = 2048 }
 The maximum number of statements a sequence can have. More...
 
enum  { Svc::Fpy::MAX_STACK_SIZE = 65535 }
 the maximum number of bytes in a stack More...
 
enum  { Svc::Fpy::MAX_DIRECTIVE_SIZE = 2048 }
 the maximum number of bytes in a directive More...
 
enum  { Svc::GenericHubCfg::NumSerialInputPorts = 10 }
 
enum  { Svc::GenericHubCfg::NumBufferInputPorts = 10 }
 
enum  { Svc::GenericHubCfg::NumSerialOutputPorts = 10 }
 
enum  { Svc::GenericHubCfg::NumBufferOutputPorts = 10 }
 
enum  { Os::FILE_MODE_IRUSR = 64 }
 
enum  { Os::FILE_MODE_IWUSR = 128 }
 
enum  { Os::FILE_MODE_IXUSR = 256 }
 
enum  { Os::FILE_MODE_IRWXU = 448 }
 
enum  { Os::FILE_MODE_IRGRP = 8 }
 
enum  { Os::FILE_MODE_IWGRP = 16 }
 
enum  { Os::FILE_MODE_IXGRP = 32 }
 
enum  { Os::FILE_MODE_IRWXG = 56 }
 
enum  { Os::FILE_MODE_IROTH = 1 }
 
enum  { Os::FILE_MODE_IWOTH = 2 }
 
enum  { Os::FILE_MODE_IXOTH = 4 }
 
enum  { Os::FILE_MODE_IRWXO = 7 }
 
enum  { Os::FILE_MODE_ISUID = 2048 }
 
enum  { Os::FILE_MODE_ISGID = 1024 }
 
enum  { Os::FILE_MODE_ISVTX = 512 }
 
enum  { Os::FILE_DEFAULT_CREATE_MODE = 219 }
 
enum  { FW_CONSOLE_HANDLE_MAX_SIZE = 24 }
 Maximum size of a handle for Os::Console. More...
 
enum  { FW_TASK_HANDLE_MAX_SIZE = 40 }
 Maximum size of a handle for Os::Task. More...
 
enum  { FW_FILE_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::File. More...
 
enum  { FW_MUTEX_HANDLE_MAX_SIZE = 72 }
 Maximum size of a handle for Os::Mutex. More...
 
enum  { FW_QUEUE_HANDLE_MAX_SIZE = 368 }
 Maximum size of a handle for Os::Queue. More...
 
enum  { FW_DIRECTORY_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::Directory. More...
 
enum  { FW_FILESYSTEM_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::FileSystem. More...
 
enum  { FW_RAW_TIME_HANDLE_MAX_SIZE = 56 }
 Maximum size of a handle for Os::RawTime. More...
 
enum  { FW_RAW_TIME_SERIALIZATION_MAX_SIZE = 8 }
 Maximum allowed serialization size for Os::RawTime objects. More...
 
enum  { FW_COUNTING_SEMAPHORE_HANDLE_MAX_SIZE = 48 }
 Maximum size of a handle for Os::CountingSemaphore. More...
 
enum  { FW_CONDITION_VARIABLE_HANDLE_MAX_SIZE = 56 }
 Maximum size of a handle for Os::ConditionVariable. More...
 
enum  { FW_CPU_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::Cpu. More...
 
enum  { FW_MEMORY_HANDLE_MAX_SIZE = 16 }
 Maximum size of a handle for Os::Memory. More...
 
enum  { FW_HANDLE_ALIGNMENT = 8 }
 Alignment of handle storage. More...
 
enum  { FW_FILE_CHUNK_SIZE = 512 }
 Chunk size for working with files in the OSAL layer. More...
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Number of rate group member output ports for ActiveRateGroup.

Enumerator
ActiveRateGroupOutputPorts 

Definition at line 13 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Number of rate group member output ports for PassiveRateGroup.

Enumerator
PassiveRateGroupOutputPorts 

Definition at line 18 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used to drive rate groups.

Enumerator
RateGroupDriverRateGroupPorts 

Definition at line 23 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for command and registration ports.

Enumerator
CmdDispatcherComponentCommandPorts 

Definition at line 28 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for uplink/sequencer buffer/response ports.

Enumerator
CmdDispatcherSequencePorts 

Definition at line 33 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for dispatching sequences to command sequencers.

Enumerator
SeqDispatcherSequencerPorts 

Definition at line 38 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for sizing the command splitter input arrays.

Enumerator
CmdSplitterPorts 

Definition at line 43 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Number of static memory allocations.

Enumerator
StaticMemoryAllocations 

Definition at line 48 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used to ping active components.

Enumerator
HealthPingPorts 

Definition at line 53 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for broadcasting completed file downlinks.

Enumerator
FileDownCompletePorts 

Definition at line 58 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for number of Fw::Com type ports supported by Svc::ComQueue.

Enumerator
ComQueueComPorts 

Definition at line 63 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for number of Fw::Buffer type ports supported by Svc::ComQueue.

Enumerator
ComQueueBufferPorts 

Definition at line 68 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Used for maximum number of connected buffer repeater consumers.

Enumerator
BufferRepeaterOutputPorts 

Definition at line 73 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of port array for DpManager.

Enumerator
DpManagerNumPorts 

Definition at line 78 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Size of processing port array for DpWriter.

Enumerator
DpWriterNumProcPorts 

Definition at line 83 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

The size of a file name string.

Enumerator
FileNameStringSize 

Definition at line 88 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

The size of an assert text string.

Enumerator
FwAssertTextSize 

Definition at line 93 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

The size of a file name in an AssertFatalAdapter event (leading-truncation) Note: File names in assertion failures are also truncated by the constants FwAssertTextSize (in this file) and FW_LOG_STRING_MAX_SIZE (set in FW_LOG_STRING_MAX_SIZE) Set much smaller than FwAssertTextSize so there's space for time stamp/assert arguments in log message

Enumerator
AssertFatalAdapterEventFileSize 

Definition at line 103 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

The maximum size in bytes for passing sequence arguments through CmdSeqIn ports Note: This must fit within FW_CMD_ARG_BUFFER_MAX_SIZE along with cmd arguments using Svc::SeqArgs Total serialized size: string length prefix + fileName + BlockState + SeqArgs(size + buffer)

Enumerator
SequenceArgumentsMaxSize 

Definition at line 110 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

When dumping the contents of the registry, this specifies the size of the buffer used to store object names. Should be >= FW_OBJ_NAME_BUFFER_SIZE.

Enumerator
FW_OBJ_SIMPLE_REG_BUFF_SIZE 

Definition at line 180 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the string holding the queue name for queues.

Enumerator
FW_QUEUE_NAME_BUFFER_SIZE 

Definition at line 185 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the string holding the task name for active components and tasks.

Enumerator
FW_TASK_NAME_BUFFER_SIZE 

Definition at line 190 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains a communications packet.

Enumerator
FW_COM_BUFFER_MAX_SIZE 

Definition at line 195 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer attached to state machine signals.

Enumerator
FW_SM_SIGNAL_BUFFER_MAX_SIZE 

Definition at line 200 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized command arguments.

Enumerator
FW_CMD_ARG_BUFFER_MAX_SIZE 

Definition at line 205 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in a command argument.

Enumerator
FW_CMD_STRING_MAX_SIZE 

Definition at line 210 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized log arguments.

Enumerator
FW_LOG_BUFFER_MAX_SIZE 

Definition at line 215 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in a log event Note: This constant truncates file names in assertion failure event reports

Enumerator
FW_LOG_STRING_MAX_SIZE 

Definition at line 221 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized telemetry value.

Enumerator
FW_TLM_BUFFER_MAX_SIZE 

Definition at line 226 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized telemetry value.

Enumerator
FW_STATEMENT_ARG_BUFFER_MAX_SIZE 

Definition at line 231 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in a telemetry channel.

Enumerator
FW_TLM_STRING_MAX_SIZE 

Definition at line 236 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the size of the buffer that contains the serialized parameter value.

Enumerator
FW_PARAM_BUFFER_MAX_SIZE 

Definition at line 241 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in a parameter.

Enumerator
FW_PARAM_STRING_MAX_SIZE 

Definition at line 246 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a file downlink chunk.

Enumerator
FW_FILE_BUFFER_MAX_SIZE 

Definition at line 251 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Specifies the maximum size of a string in an interface call.

Enumerator
FW_INTERNAL_INTERFACE_STRING_MAX_SIZE 

Definition at line 256 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Defines the size of the text log string buffer. Should be large enough for format string and arguments.

Enumerator
FW_LOG_TEXT_BUFFER_SIZE 

Definition at line 261 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Configuration for Fw::String Note: FPrimeBasicTypes.hpp needs to be updated to sync enum

Enumerator
FW_FIXED_LENGTH_STRING_SIZE 

Definition at line 267 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

For the simple object registry provided with the framework, this specifies how many objects the registry will store.

Enumerator
FW_OBJ_SIMPLE_REG_ENTRIES 

Definition at line 272 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

For the simple queue registry provided with the framework, this specifies how many queues the registry will store.

Enumerator
FW_QUEUE_SIMPLE_QUEUE_ENTRIES 

Definition at line 277 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum number of cascading FW_ASSERT check failures before forcing a system assert.

Enumerator
FW_ASSERT_COUNT_MAX 

Definition at line 282 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Don't care value for time contexts in sequences.

Enumerator
FW_CONTEXT_DONT_CARE 

Definition at line 287 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Value encoded during serialization for boolean true.

Enumerator
FW_SERIALIZE_TRUE_VALUE 

Definition at line 292 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Value encoded during serialization for boolean false.

Enumerator
FW_SERIALIZE_FALSE_VALUE 

Definition at line 297 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Console.

Enumerator
FW_CONSOLE_HANDLE_MAX_SIZE 

Definition at line 436 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Task.

Enumerator
FW_TASK_HANDLE_MAX_SIZE 

Definition at line 441 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::File.

Enumerator
FW_FILE_HANDLE_MAX_SIZE 

Definition at line 446 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Mutex.

Enumerator
FW_MUTEX_HANDLE_MAX_SIZE 

Definition at line 451 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Queue.

Enumerator
FW_QUEUE_HANDLE_MAX_SIZE 

Definition at line 456 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Directory.

Enumerator
FW_DIRECTORY_HANDLE_MAX_SIZE 

Definition at line 461 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::FileSystem.

Enumerator
FW_FILESYSTEM_HANDLE_MAX_SIZE 

Definition at line 466 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::RawTime.

Enumerator
FW_RAW_TIME_HANDLE_MAX_SIZE 

Definition at line 471 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum allowed serialization size for Os::RawTime objects.

Enumerator
FW_RAW_TIME_SERIALIZATION_MAX_SIZE 

Definition at line 476 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::CountingSemaphore.

Enumerator
FW_COUNTING_SEMAPHORE_HANDLE_MAX_SIZE 

Definition at line 481 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::ConditionVariable.

Enumerator
FW_CONDITION_VARIABLE_HANDLE_MAX_SIZE 

Definition at line 486 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Cpu.

Enumerator
FW_CPU_HANDLE_MAX_SIZE 

Definition at line 491 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Maximum size of a handle for Os::Memory.

Enumerator
FW_MEMORY_HANDLE_MAX_SIZE 

Definition at line 496 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Alignment of handle storage.

Enumerator
FW_HANDLE_ALIGNMENT 

Definition at line 501 of file FppConstantsAc.hpp.

◆ anonymous enum

anonymous enum

Chunk size for working with files in the OSAL layer.

Enumerator
FW_FILE_CHUNK_SIZE 

Definition at line 506 of file FppConstantsAc.hpp.