Merge pull request #152 from nasa/integration-candidate

sch_lab Integration candidate: Caelum-rc4+dev63

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Development Build: v2.5.0-rc4+dev61
+- implement header file convention for SCH_LAB
+- See <https://github.com/nasa/sch_lab/pull/151>
+
 ## Development Build: v2.5.0-rc4+dev57
 - Add support for cmds w/args
 - See <https://github.com/nasa/sch_lab/pull/144>

CMakeLists.txt

@@ -17,8 +17,3 @@ endforeach()
 # Create the app module
 add_cfe_app(sch_lab fsw/src/sch_lab_app.c)
 add_cfe_tables(sch_lab fsw/tables/sch_lab_table.c)
-
-target_include_directories(sch_lab PUBLIC
-    fsw/mission_inc
-    fsw/platform_inc
-)

arch_build.cmake

@@ -0,0 +1,24 @@
+###########################################################
+#
+# SCH_LAB platform build setup
+#
+# This file is evaluated as part of the "prepare" stage
+# and can be used to set up prerequisites for the build,
+# such as generating header files
+#
+###########################################################
+
+# The list of header files that control the SCH_LAB configuration
+set(SCH_LAB_PLATFORM_CONFIG_FILE_LIST
+  sch_lab_perfids.h
+)
+
+# Create wrappers around the all the config header files
+# This makes them individually overridable by the missions, without modifying
+# the distribution default copies
+foreach(SCH_LAB_CFGFILE ${SCH_LAB_PLATFORM_CONFIG_FILE_LIST})
+  generate_config_includefile(
+    FILE_NAME           "${SCH_LAB_CFGFILE}"
+    FALLBACK_FILE       "${CMAKE_CURRENT_LIST_DIR}/config/default_${SCH_LAB_CFGFILE}"
+  )
+endforeach()

config/default_sch_lab_interface_cfg.h

@@ -0,0 +1,46 @@
+/************************************************************************
+ * NASA Docket No. GSC-18,719-1, and identified as “core Flight System: Bootes”
+ *
+ * Copyright (c) 2020 United States Government as represented by the
+ * Administrator of the National Aeronautics and Space Administration.
+ * All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ************************************************************************/
+
+/**
+ * @file
+ *
+ * CFS SCH_LAB Application Mission Configuration Header File
+ *
+ * This is a compatibility header for the "mission_cfg.h" file that has
+ * traditionally provided public config definitions for each CFS app.
+ *
+ * @note This file may be overridden/superceded by mission-provided defintions
+ * either by overriding this header or by generating definitions from a command/data
+ * dictionary tool.
+ */
+#ifndef SCH_LAB_INTERFACE_CFG_H
+#define SCH_LAB_INTERFACE_CFG_H
+
+/**
+ * @brief The maximum number of schedule table entries
+ */
+#define SCH_LAB_MAX_SCHEDULE_ENTRIES 32
+
+/**
+ * @brief The maximum number of arguments to each schedule message entry
+ *
+ * This is allocated in units of 16 bit words.
+ */
+#define SCH_LAB_MAX_ARGS_PER_ENTRY 32
+
+#endif /* SCH_LAB_INTERFACE_CFG_H */

config/default_sch_lab_mission_cfg.h

@@ -0,0 +1,36 @@
+/************************************************************************
+ * NASA Docket No. GSC-18,719-1, and identified as “core Flight System: Bootes”
+ *
+ * Copyright (c) 2020 United States Government as represented by the
+ * Administrator of the National Aeronautics and Space Administration.
+ * All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ************************************************************************/
+
+/**
+ * @file
+ *
+ * CFS SCH_LAB Application Mission Configuration Header File
+ *
+ * This is a compatibility header for the "mission_cfg.h" file that has
+ * traditionally provided public config definitions for each CFS app.
+ *
+ * @note This file may be overridden/superceded by mission-provided defintions
+ * either by overriding this header or by generating definitions from a command/data
+ * dictionary tool.
+ */
+#ifndef SCH_LAB_MISSION_CFG_H
+#define SCH_LAB_MISSION_CFG_H
+
+#include "sch_lab_interface_cfg.h"
+
+#endif /* SCH_LAB_MISSION_CFG_H */

fsw/mission_inc/sch_lab_perfids.h → config/default_sch_lab_perfids.h

@@ -19,6 +19,9 @@
 /**
  * @file
  *  Define SCH Lab Performance IDs
+ *
+ * These ID values need to be unique across a CFS deployment, so they may be customized
+ * as needed to avoid collision with other apps.
  */
 #ifndef SCH_LAB_PERFIDS_H
 #define SCH_LAB_PERFIDS_H

config/default_sch_lab_tbl.h

@@ -0,0 +1,48 @@
+/************************************************************************
+ * NASA Docket No. GSC-18,719-1, and identified as “core Flight System: Bootes”
+ *
+ * Copyright (c) 2020 United States Government as represented by the
+ * Administrator of the National Aeronautics and Space Administration.
+ * All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ************************************************************************/
+
+/**
+ * @file
+ *   Specification for the SCH_LAB table structures
+ *
+ * @note
+ *   Constants and enumerated types related to these table structures
+ *   are defined in sch_lab_tbldefs.h.
+ */
+#ifndef SCH_LAB_TBL_H
+#define SCH_LAB_TBL_H
+
+#include "sch_lab_tbldefs.h"
+#include "sch_lab_tblstruct.h"
+
+/*
+** Defines
+*/
+#ifdef SOFTWARE_BIG_BIT_ORDER
+#define SCH_PACK_32BIT(value) (uint16)((value & 0xFFFF0000) >> 16), (uint16)(value & 0x0000FFFF)
+#else
+#define SCH_PACK_32BIT(value) (uint16)(value & 0x0000FFFF), (uint16)((value & 0xFFFF0000) >> 16)
+#endif
+
+/*
+ * There is no extra encapsulation here, this header only
+ * defines the default file name to use for the SCH table
+ */
+#define SCH_TBL_DEFAULT_FILE "/cf/sch_lab_table.tbl"
+
+#endif

config/default_sch_lab_tbldefs.h

@@ -0,0 +1,49 @@
+/************************************************************************
+ * NASA Docket No. GSC-18,719-1, and identified as “core Flight System: Bootes”
+ *
+ * Copyright (c) 2020 United States Government as represented by the
+ * Administrator of the National Aeronautics and Space Administration.
+ * All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ************************************************************************/
+
+/**
+ * @file
+ *   Specification for the CFS SCH_LAB table related data structures and
+ *   constant definitions.
+ *
+ * The structure definitions in this file are closely related to the implementation
+ * of the application.  Any modification to these structures will likely need
+ * a correpsonding update to the source code.
+ */
+#ifndef SCH_LAB_TBLDEFS_H
+#define SCH_LAB_TBLDEFS_H
+
+#include "cfe_sb_extern_typedefs.h" /* for CFE_SB_MsgId_t */
+#include "cfe_msg_api_typedefs.h"   /* For CFE_MSG_FcnCode_t */
+#include "cfe_msgids.h"
+
+#include "sch_lab_mission_cfg.h"
+
+/*
+** Typedefs
+*/
+typedef struct
+{
+    CFE_SB_MsgId_t    MessageID;                                 /* Message ID for the table entry */
+    uint32            PacketRate;                                /* Rate: Send packet every N ticks */
+    CFE_MSG_FcnCode_t FcnCode;                                   /* Command/Function code to set */
+    uint16            PayloadLength;                             /* Length of additional command args */
+    uint16            MessageBuffer[SCH_LAB_MAX_ARGS_PER_ENTRY]; /* Command args in 16 bit words */
+} SCH_LAB_ScheduleTableEntry_t;
+
+#endif

config/default_sch_lab_tblstruct.h

@@ -0,0 +1,41 @@
+/************************************************************************
+ * NASA Docket No. GSC-18,719-1, and identified as “core Flight System: Bootes”
+ *
+ * Copyright (c) 2020 United States Government as represented by the
+ * Administrator of the National Aeronautics and Space Administration.
+ * All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ************************************************************************/
+
+/**
+ * @file
+ *   Specification for the CFS SCH_LAB table encapsulation structures
+ *
+ * Provides default definitions for SCH_LAB table structures
+ *
+ * @note This file may be overridden/superceded by mission-provided defintions
+ * either by overriding this header or by generating definitions from a command/data
+ * dictionary tool.
+ */
+#ifndef SCH_LAB_TBLSTRUCT_H
+#define SCH_LAB_TBLSTRUCT_H
+
+#include "sch_lab_mission_cfg.h"
+#include "sch_lab_tbldefs.h"
+
+typedef struct
+{
+    uint32                       TickRate; /* Ticks per second to configure for timer (0=default) */
+    SCH_LAB_ScheduleTableEntry_t Config[SCH_LAB_MAX_SCHEDULE_ENTRIES];
+} SCH_LAB_ScheduleTable_t;
+
+#endif