Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

psp Integration candidate: Caelum-rc4+dev4 #326

Merged
merged 5 commits into from
Feb 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This is a collection of APIs abstracting platform specific functionality to be l

## Version History

### Development Build: v1.6.0-rc4+dev14

- Remove explicit filename doxygen comments
- Apply header guard standard
- See <https://github.com/nasa/PSP/pull/326> and <https://github.com/nasa/cFS/pull/432>


### Development Build: v1.6.0-rc4+dev6

Expand Down
8 changes: 3 additions & 5 deletions fsw/inc/cfe_psp.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
*/

/*
** File Name: cfe_psp.h
**
** Author: A. Cudmore
**
** Purpose: This file contains the cFE Platform Support Package(PSP)
Expand All @@ -33,8 +31,8 @@
**
*/

#ifndef _cfe_psp_
#define _cfe_psp_
#ifndef CFE_PSP_H
#define CFE_PSP_H

/*
** Include Files
Expand Down Expand Up @@ -490,4 +488,4 @@ void CFE_PSP_GetVersionNumber(uint8 VersionNumbers[4]);
*/
uint32 CFE_PSP_GetBuildNumber(void);

#endif /* _cfe_psp_ */
#endif
9 changes: 2 additions & 7 deletions fsw/mcp750-vxworks/inc/cfe_psp_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,8 @@
** limitations under the License.
*/

/*
** cfe_psp_config.h
**
*/

#ifndef _cfe_psp_config_
#define _cfe_psp_config_
#ifndef CFE_PSP_CONFIG_H
#define CFE_PSP_CONFIG_H

#include "common_types.h"

Expand Down
10 changes: 5 additions & 5 deletions fsw/mcp750-vxworks/inc/psp_version.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@
** limitations under the License.
*/

/*! @file mcp750-vxworks/inc/psp_version.h
/*! @file
* @brief Purpose:
* @details Provide version identifiers for the cFE Platform Support Packages (PSP).
* See @ref cfsversions for version and build number and description
*/
#ifndef _psp_version_
#define _psp_version_
#ifndef PSP_VERSION_H
#define PSP_VERSION_H

/*
* Development Build Macro Definitions
*/
#define CFE_PSP_IMPL_BUILD_NUMBER 4
#define CFE_PSP_IMPL_BUILD_NUMBER 14
#define CFE_PSP_IMPL_BUILD_BASELINE "v1.6.0-rc1"

/*
Expand Down Expand Up @@ -70,4 +70,4 @@
" PSP DEVELOPMENT BUILD " CFE_PSP_IMPL_VERSION \
", Last Official Release: psp v1.4.0" /* For full support please use this version */

#endif /* _psp_version_ */
#endif
2 changes: 1 addition & 1 deletion fsw/modules/eeprom_mmap_file/cfe_psp_eeprom_mmap_file.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_eeprom_mmap_file.c
* \file
*
* Created on: Jul 17, 2015
* Author: joseph.p.hickey@nasa.gov
Expand Down
2 changes: 1 addition & 1 deletion fsw/modules/eeprom_notimpl/cfe_psp_eeprom_notimpl.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_eeprom_notimpl.c
* \file
*
* A PSP module to satisfy the "EEPROM" API on systems which
* do not have an EEPROM or otherwise cannot access it.
Expand Down
2 changes: 1 addition & 1 deletion fsw/modules/port_direct/cfe_psp_port_direct.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_port_direct.c
* \file
*
* A PSP module to satisfy the "PORT" API on systems which
* can access I/O ports directly via memory mapped addresses.
Expand Down
2 changes: 1 addition & 1 deletion fsw/modules/port_notimpl/cfe_psp_port_notimpl.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_port_notimpl.c
* \file
*
* A PSP module to satisfy the "Port" API on systems which
* do not have or otherwise cannot access I/O ports.
Expand Down
2 changes: 1 addition & 1 deletion fsw/modules/ram_direct/cfe_psp_ram_direct.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_ram_direct.c
* \file
*
* A PSP module to satisfy the "RAM" API on systems which
* can access physical memory directly.
Expand Down
2 changes: 1 addition & 1 deletion fsw/modules/ram_notimpl/cfe_psp_ram_notimpl.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_ram_notimpl.c
* \file
*
* A PSP module to satisfy the "RAM" API on systems which
* cannot access physical memory directly.
Expand Down
2 changes: 1 addition & 1 deletion fsw/modules/soft_timebase/cfe_psp_soft_timebase.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_soft_timebase.c
* \file
*
* A PSP module that instantiates an RTOS-backed OSAL timebase to provide
* various timing services. This in turn may be used to drive CFE TIME 1Hz
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_timebase_posix_clock.c
* \file
*
* A PSP module to satisfy the PSP time API on systems which
* do not have a hardware clock register, but do provide a POSIX
Expand Down
2 changes: 1 addition & 1 deletion fsw/modules/timebase_vxworks/cfe_psp_timebase_vxworks.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_timebase_vxworks.c
* \file
*
* A PSP module to implement the PSP time API via the VxWorks
* vxTimeBaseGet() routine. The VxWorks timebase is a 64 bit
Expand Down
8 changes: 2 additions & 6 deletions fsw/pc-linux/inc/cfe_psp_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,8 @@
** limitations under the License.
*/

/*
** cfe_psp_config.h
*/

#ifndef _cfe_psp_config_
#define _cfe_psp_config_
#ifndef CFE_PSP_CONFIG_H
#define CFE_PSP_CONFIG_H

#include "common_types.h"

Expand Down
10 changes: 5 additions & 5 deletions fsw/pc-linux/inc/psp_version.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@
** limitations under the License.
*/

/*! @file pc-linux/inc/psp_version.h
/*! @file
* @brief Purpose:
* @details Provide version identifiers for the cFE Platform Support Packages (PSP).
* See @ref cfsversions for version and build number and description
*/
#ifndef _psp_version_
#define _psp_version_
#ifndef PSP_VERSION_H
#define PSP_VERSION_H

/*
* Development Build Macro Definitions
*/
#define CFE_PSP_IMPL_BUILD_NUMBER 4
#define CFE_PSP_IMPL_BUILD_NUMBER 14
#define CFE_PSP_IMPL_BUILD_BASELINE "v1.6.0-rc1"

/*
Expand Down Expand Up @@ -70,4 +70,4 @@
" PSP DEVELOPMENT BUILD " CFE_PSP_IMPL_VERSION \
", Last Official Release: psp v1.4.0" /* For full support please use this version */

#endif /* _psp_version_ */
#endif
9 changes: 2 additions & 7 deletions fsw/pc-rtems/inc/cfe_psp_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,8 @@
** limitations under the License.
*/

/*
** cfe_psp_config.h
**
*/

#ifndef _cfe_psp_config_
#define _cfe_psp_config_
#ifndef CFE_PSP_CONFIG_H
#define CFE_PSP_CONFIG_H

#include "common_types.h"
#include <rtems.h>
Expand Down
10 changes: 5 additions & 5 deletions fsw/pc-rtems/inc/psp_version.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@
** limitations under the License.
*/

/*! @file pc-rtems/inc/psp_version.h
/*! @file
* @brief Purpose:
* @details Provide version identifiers for the cFE Platform Support Packages (PSP).
* See @ref cfsversions for version and build number and description
*/
#ifndef _psp_version_
#define _psp_version_
#ifndef PSP_VERSION_H
#define PSP_VERSION_H

/*
* Development Build Macro Definitions
*/
#define CFE_PSP_IMPL_BUILD_NUMBER 4
#define CFE_PSP_IMPL_BUILD_NUMBER 14
#define CFE_PSP_IMPL_BUILD_BASELINE "v1.6.0-rc1"

/*
Expand Down Expand Up @@ -70,4 +70,4 @@
" PSP DEVELOPMENT BUILD " CFE_PSP_IMPL_VERSION \
", Last Official Release: psp v1.4.0" /* For full support please use this version */

#endif /* _psp_version_ */
#endif
2 changes: 1 addition & 1 deletion fsw/shared/inc/cfe_psp_exceptionstorage_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_exceptionstorage_api.h
* \file
*
* Provides a generic storage buffer ring for exceptions
*/
Expand Down
2 changes: 1 addition & 1 deletion fsw/shared/inc/cfe_psp_exceptionstorage_types.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_exceptionstorage_types.h
* \file
*
* Provides a generic storage buffer ring for exceptions
*/
Expand Down
8 changes: 3 additions & 5 deletions fsw/shared/inc/cfe_psp_memory.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
*/

/*
** File Name: cfe_psp_memory.h
**
** Author: A. Cudmore
**
** Purpose: This file contains PSP support routine internal prototypes
Expand All @@ -31,8 +29,8 @@
**
*/

#ifndef _cfe_psp_memory_
#define _cfe_psp_memory_
#ifndef CFE_PSP_MEMORY_H
#define CFE_PSP_MEMORY_H

/*
** Include Files
Expand Down Expand Up @@ -120,4 +118,4 @@ extern void CFE_PSP_DeleteProcessorReservedMemory(void);
*/
extern CFE_PSP_ReservedMemoryMap_t CFE_PSP_ReservedMemoryMap;

#endif /* _cfe_psp_memory_ */
#endif
2 changes: 1 addition & 1 deletion fsw/shared/inc/cfe_psp_module.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_module.h
* \file
*
* Created on: Jul 17, 2015
* Author: joseph.p.hickey@nasa.gov
Expand Down
2 changes: 1 addition & 1 deletion fsw/shared/src/cfe_psp_module.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_module.c
* \file
*
* Created on: Jul 25, 2014
* Author: jphickey
Expand Down
2 changes: 1 addition & 1 deletion fsw/shared/src/cfe_psp_version.c
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*/

/**
* \file cfe_psp_version.c
* \file
*
* Defines API that obtains the values of the various version identifiers
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@
*/

/**
* \file ut-adaptor-bootrec.h
* \file
* \ingroup adaptors
* \author joseph.p.hickey@nasa.gov
*
*/

#ifndef INCLUDE_UT_ADAPTOR_BOOTREC_H_
#define INCLUDE_UT_ADAPTOR_BOOTREC_H_
#ifndef UT_ADAPTOR_BOOTREC_H
#define UT_ADAPTOR_BOOTREC_H

#include "common_types.h"

void UT_Setup_ReservedMem_BootRec(void);
uint32 UT_Get_ReservedMem_BootType(void);
void UT_Set_ReservedMem_BootType(uint32 reset_type);

#endif /* INCLUDE_UT_ADAPTOR_BOOTREC_H_ */
#endif
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*/

/**
* \file ut-adaptor-bootrec.c
* \file
* \ingroup adaptors
* \author joseph.p.hickey@nasa.gov
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*/

/**
* \file coveragetest-binsem.c
* \file
* \ingroup vxworks
* \author joseph.p.hickey@nasa.gov
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*/

/**
* \file coveragetest-binsem.c
* \file
* \ingroup vxworks
* \author joseph.p.hickey@nasa.gov
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*/

/**
* \file coveragetest-binsem.c
* \file
* \ingroup vxworks
* \author joseph.p.hickey@nasa.gov
*
Expand Down
Loading