Merge pull request #300 from thnkslprpt/FIX-PSP-TYPOS

Fixed various typos in docs and comments

Part of nasa/cFS#352

README.md

@@ -34,7 +34,7 @@ or any other system where direct access is not possible.  Renames the existing `
 
 ### Development Build: v1.5.0-rc1+dev101
 
-- Removes unnecessary global config structure `Target_PspConfigData` and associated elements infavor of the new version API.
+- Removes unnecessary global config structure `Target_PspConfigData` and associated elements in favor of the new version API.
 - The mem pool stats TLM command now works on 64-bit Linux and sends out the expected telemetry packet.
 Converts `CFE_PSP_MemoryTable` to internal object (instead of external) that should only be accessed via the PSP API. Replace `uint32`s with `size_t`. Use full range (SIZE_MAX) in the Linux/RTEMS implementation.
 - See <https://github.com/nasa/PSP/pull/288> and <https://github.com/nasa/cFS/pull/233>
@@ -68,7 +68,7 @@ Converts `CFE_PSP_MemoryTable` to internal object (instead of external) that sho
 
 ### Development Build: 1.5.0-rc1+dev68
 
-- Updates continuous integration workfow by adding static analysis with timeout and code format check. Adds status badges to ReadMe and removes old TravisCI artifacts.
+- Updates continuous integration workflow by adding static analysis with timeout and code format check. Adds status badges to ReadMe and removes old Travis-CI artifacts.
 - Adds CodeQL analysis to continuous integration
 - Apply standard formatting to psp codebase. Only changes whitespace.
 - Adds missing "+dev" to development version output

SECURITY.md

@@ -6,7 +6,7 @@ To report a vulnerability for the PSP subsystem please [submit an issue](https:/
 
 For general cFS vulnerabilities please [open a cFS framework issue](https://github.com/nasa/cfs/issues/new/choose) and see our [top-level security policy](https://github.com/nasa/cFS/security/policy).
 
-In either case please use the "Bug Report" template and provide as much information as possible. Apply appropraite labels for each report. For security related reports, tag the issue with the "security" label.
+In either case please use the "Bug Report" template and provide as much information as possible. Apply appropriate labels for each report. For security related reports, tag the issue with the "security" label.
 
 ## Testing
 

fsw/inc/cfe_psp.h

@@ -178,7 +178,7 @@ extern void CFE_PSP_Main(void);
  *
  * Outputs an OS_time_t value indicating the time elapsed since an epoch.  The
  * epoch is not defined, but typically represents the system boot time.  The
- * value increases continously over time and cannot be reset by software.
+ * value increases continuously over time and cannot be reset by software.
  *
  * This is similar to the CFE_PSP_Get_Timebase(), but additionally it normalizes
  * the output value to an OS_time_t, thereby providing consistent units to
@@ -221,7 +221,7 @@ extern uint32 CFE_PSP_GetProcessorId(void);
 
 extern uint32 CFE_PSP_GetSpacecraftId(void);
 /*
-** CFE_PSP_GetSpacecraftId retuns the Spacecraft ID (if any )
+** CFE_PSP_GetSpacecraftId returns the Spacecraft ID (if any )
 */
 
 extern const char *CFE_PSP_GetProcessorName(void);
@@ -380,7 +380,7 @@ extern void CFE_PSP_AttachExceptions(void);
 /*
 ** CFE_PSP_AttachExceptions will setup the exception environment for the chosen platform
 ** On a board, this can be configured to look at a debug flag or switch in order to
-** keep the standard OS exeption handlers, rather than restarting the system
+** keep the standard OS exception handlers, rather than restarting the system
 */
 
 extern void CFE_PSP_SetDefaultExceptionEnvironment(void);

fsw/mcp750-vxworks/inc/cfe_psp_config.h

@@ -55,7 +55,7 @@
 #define CFE_PSP_VX_TIMEBASE_PERIOD_DENOMINATOR 1
 
 /*
-** This define sets the number of memory ranges that are defined in the memory range defintion
+** This define sets the number of memory ranges that are defined in the memory range definition
 ** table.
 */
 #define CFE_PSP_MEM_TABLE_SIZE 10

fsw/mcp750-vxworks/src/cfe_psp_exception.c

@@ -76,7 +76,7 @@ void CFE_PSP_ExceptionHook(TASK_ID task_id, int vector, void *vpEsf);
 **
 **   Name: CFE_PSP_AttachExceptions
 **
-**   Purpose: This function Initializes the task execptions and adds a hook
+**   Purpose: This function Initializes the task exceptions and adds a hook
 **              into the VxWorks exception handling.  The below hook is called
 **              for every exception that VxWorks catches.
 **
@@ -178,7 +178,7 @@ void CFE_PSP_SetDefaultExceptionEnvironment(void)
 
     vxFpscrSet(vxFpscrGet() | _PPC_FPSCR_VE | /* enable exceptions for invalid operations */
                _PPC_FPSCR_OE |                /* enable overflow exceptions */
-               _PPC_FPSCR_NI |                /* Non-IEEE mode for denormailized numbers */
+               _PPC_FPSCR_NI |                /* Non-IEEE mode for denormalized numbers */
                _PPC_FPSCR_ZE);                /* enable divide by zero exceptions */
 
     vxFpscrSet(vxFpscrGet() | _PPC_FPSCR_XE | /* fp inexact exc enable */

fsw/mcp750-vxworks/src/cfe_psp_memory.c

@@ -26,7 +26,7 @@
 ** Purpose:
 **   cFE PSP Memory related functions. This is the implementation of the cFE
 **   memory areas that have to be preserved, and the API that is designed to allow
-**   acccess to them. It also contains memory related routines to return the
+**   access to them. It also contains memory related routines to return the
 **   address of the kernel code used in the cFE checksum.
 **
 ** History:
@@ -457,7 +457,7 @@ int32 CFE_PSP_GetKernelTextSegmentInfo(cpuaddr *PtrToKernelSegment, uint32 *Size
         /*
         ** Get the kernel start and end
         ** addresses from the BSP, because the
-        ** symbol table does not contain the symbls we need for this
+        ** symbol table does not contain the symbols we need for this
         */
         StartAddress = (cpuaddr)GetWrsKernelTextStart();
         EndAddress   = (cpuaddr)GetWrsKernelTextEnd();

fsw/mcp750-vxworks/src/cfe_psp_ssr.c

@@ -24,7 +24,7 @@
 ** Purpose:
 **   This file contains glue routines between the cFE and the OS Board Support Package ( BSP ).
 **   The functions here allow the cFE to interface functions that are board and OS specific
-**   and usually dont fit well in the OS abstraction layer.
+**   and usually don't fit well in the OS abstraction layer.
 **
 ** History:
 **   2005/06/05  Alan Cudmore    | Initial version,

fsw/mcp750-vxworks/src/cfe_psp_start.c

@@ -118,7 +118,7 @@ void OS_Application_Startup(void)
 
     /*
     ** Set up the virtual FS mapping for the "/cf" directory
-    ** On this platform it is will use the CF:0 physical device.
+    ** On this platform it will use the CF:0 physical device.
     */
     Status = OS_FileSysAddFixedMap(&fs_id, "CF:0", "/cf");
     if (Status != OS_SUCCESS)

fsw/mcp750-vxworks/src/cfe_psp_support.c

@@ -24,7 +24,7 @@
 ** Purpose:
 **   This file contains glue routines between the cFE and the OS Board Support Package ( BSP ).
 **   The functions here allow the cFE to interface functions that are board and OS specific
-**   and usually dont fit well in the OS abstraction layer.
+**   and usually don't fit well in the OS abstraction layer.
 **
 ** History:
 **   2005/06/05  Alan Cudmore    | Initial version,

fsw/mcp750-vxworks/src/cfe_psp_watchdog.c

@@ -24,7 +24,7 @@
 ** Purpose:
 **   This file contains glue routines between the cFE and the OS Board Support Package ( BSP ).
 **   The functions here allow the cFE to interface functions that are board and OS specific
-**   and usually dont fit well in the OS abstraction layer.
+**   and usually don't fit well in the OS abstraction layer.
 **
 ** History:
 **   2009/07/20  A. Cudmore    | Initial version,

fsw/modules/eeprom_direct/cfe_psp_eeprom_direct.c

@@ -273,7 +273,7 @@ int32 CFE_PSP_EepromWrite8(cpuaddr MemoryAddress, uint8 ByteValue)
 ** Name: CFE_PSP_EepromWriteEnable
 **
 ** Purpose:
-**		Eable the eeprom for write operation
+**		Enable the eeprom for write operation
 **
 ** Assumptions and Notes:
 **

fsw/modules/eeprom_mmap_file/cfe_psp_eeprom_mmap_file.c

@@ -128,7 +128,7 @@ int32 CFE_PSP_SetupEEPROM(uint32 EEPROMSize, cpuaddr *EEPROMAddress)
 
 /* For read/write - As this is mmap'ed we dereference the pointer directly.
  * Hopefully the caller didn't get it wrong.
- * No need to anything special for 8/16/32 width access in this mode.
+ * No need to do anything special for 8/16/32 width access in this mode.
  */
 int32 CFE_PSP_EepromWrite32(cpuaddr MemoryAddress, uint32 uint32Value)
 {

fsw/pc-linux/inc/cfe_psp_config.h

@@ -32,7 +32,7 @@
 #include <pthread.h>
 
 /*
-** This define sets the number of memory ranges that are defined in the memory range defintion
+** This define sets the number of memory ranges that are defined in the memory range definition
 ** table.
 */
 #define CFE_PSP_MEM_TABLE_SIZE 10

fsw/pc-linux/src/cfe_psp_memory.c

@@ -26,7 +26,7 @@
 ** Purpose:
 **   cFE PSP Memory related functions. This is the implementation of the cFE
 **   memory areas that have to be preserved, and the API that is designed to allow
-**   acccess to them. It also contains memory related routines to return the
+**   access to them. It also contains memory related routines to return the
 **   address of the kernel code used in the cFE checksum.
 **
 ** History:

fsw/pc-linux/src/cfe_psp_ssr.c

@@ -24,7 +24,7 @@
 ** Purpose:
 **   This file contains glue routines between the cFE and the OS Board Support Package ( BSP ).
 **   The functions here allow the cFE to interface functions that are board and OS specific
-**   and usually dont fit well in the OS abstraction layer.
+**   and usually don't fit well in the OS abstraction layer.
 **
 ** History:
 **   2005/06/05  Alan Cudmore    | Initial version,

fsw/pc-linux/src/cfe_psp_support.c

@@ -24,7 +24,7 @@
 ** Purpose:
 **   This file contains glue routines between the cFE and the OS Board Support Package ( BSP ).
 **   The functions here allow the cFE to interface functions that are board and OS specific
-**   and usually dont fit well in the OS abstraction layer.
+**   and usually don't fit well in the OS abstraction layer.
 **
 ******************************************************************************/
 

fsw/pc-linux/src/cfe_psp_watchdog.c

@@ -24,7 +24,7 @@
 ** Purpose:
 **   This file contains glue routines between the cFE and the OS Board Support Package ( BSP ).
 **   The functions here allow the cFE to interface functions that are board and OS specific
-**   and usually dont fit well in the OS abstraction layer.
+**   and usually don't fit well in the OS abstraction layer.
 **
 ** History:
 **   2009/07/20  A. Cudmore    | Initial version,

fsw/pc-rtems/README.txt

@@ -19,9 +19,9 @@ I. Setting up and compiling RTEMS BSP
 
 1) install RTEMS toolchain for i386-rtems4.11 (or relevant target arch) into /opt/rtems-4.11
 
-The RTEMS official docs have instructions for this, which should supercede anything here.
+The RTEMS official docs have instructions for this, which should supersede anything here.
 
-Basic use of the the "rtems source builder" tool which works at the time of this writing:
+Basic use of the "rtems source builder" tool which works at the time of this writing:
 OFFICIAL RTEMS SOURCE BUILDER CLONE URL: git://git.rtems.org/rtems-source-builder.git
 
 
@@ -171,10 +171,10 @@ set(RTEMS_RELOCADDR 0x00100000)
 
 2) Get RTEMS GRUB boot image
 
-NOTE: The GRUB image is not needed when using QEMU.  The "-kernel" option to QEMU makes things
+NOTE: The GRUB image is not needed when using QEMU. The "-kernel" option to QEMU makes things
 much easier and is highly recommended.
 
-RTEMS binaries cannot be directly booted by a PC BIOS...  Grub is one way to boot RTEMS.
+RTEMS binaries cannot be directly booted by a PC BIOS... Grub is one way to boot RTEMS.
 
 Instructions for building GRUB for use with RTEMS@
 
@@ -253,7 +253,7 @@ an interactive user to query/interact with the system as part of the unit testin
 The BSP also supports a "--batch-mode" option which is intended for 
 automated or script-based execution.  It can be invoked through QEMU's 
 "-append" option or through the GRUB bootloader if using real hardware.
-When using QEMU this allows for  fully scripted testing.  
+When using QEMU this allows for fully scripted testing.
 
 The basic QEMU command to execute a single unit test is:
 

fsw/pc-rtems/README_RTEMS_5.txt

@@ -20,9 +20,9 @@ I. Setting up and compiling RTEMS BSP
 
 1) install RTEMS toolchain for i386-rtems5 (or relevant target arch) into ${HOME}/rtems5
 
-The RTEMS official docs have instructions for this, which should supercede anything here.
+The RTEMS official docs have instructions for this, which should supersede anything here.
 
-Basic use of the the "rtems source builder" tool which works at the time of this writing:
+Basic use of the "rtems source builder" tool which works at the time of this writing:
 OFFICIAL RTEMS SOURCE BUILDER CLONE URL: git://git.rtems.org/rtems-source-builder.git
 
 
@@ -37,7 +37,7 @@ cd rtems-source-builder/rtems
 Note - at the time of this writing 5.1 is the current "stable" branch and
 5.1 represents the latest point release tag on that branch. We are going to
 use the "5" branch, which will eventually be released as 5.2. The latest
-5 branch has a bux fix for the RFS file system needed by the cFS for this target.
+5 branch has a bug fix for the RFS file system needed by the cFS for this target.
 If you use the 5.1 release tag (or tarball) you will most likely not be able
 to run the cFS without an error.
 
@@ -259,7 +259,7 @@ an interactive user to query/interact with the system as part of the unit testin
 The BSP also supports a "--batch-mode" option which is intended for 
 automated or script-based execution.  It can be invoked through QEMU's 
 "-append" option or through the GRUB bootloader if using real hardware.
-When using QEMU this allows for  fully scripted testing.  
+When using QEMU this allows for fully scripted testing.  
 
 The basic QEMU command to execute a single unit test is:
 

fsw/pc-rtems/inc/cfe_psp_config.h

@@ -30,7 +30,7 @@
 #include <rtems.h>
 
 /*
-** This define sets the number of memory ranges that are defined in the memory range defintion
+** This define sets the number of memory ranges that are defined in the memory range definition
 ** table.
 */
 #define CFE_PSP_MEM_TABLE_SIZE 10

fsw/pc-rtems/src/cfe_psp_memory.c

@@ -26,7 +26,7 @@
 ** Purpose:
 **   cFE PSP Memory related functions. This is the implementation of the cFE
 **   memory areas that have to be preserved, and the API that is designed to allow
-**   acccess to them. It also contains memory related routines to return the
+**   access to them. It also contains memory related routines to return the
 **   address of the kernel code used in the cFE checksum.
 **
 ** History:
@@ -373,7 +373,7 @@ void CFE_PSP_SetupReservedMemoryMap(void)
     RequiredSize += CDSSize;
     RequiredSize += UserReservedSize;
 
-    OS_printf("Sizeof BSP reserved memory = %u bytes\n", (unsigned int)RequiredSize);
+    OS_printf("Size of BSP reserved memory = %u bytes\n", (unsigned int)RequiredSize);
 
     PcRtems_ReservedMemBlock.BlockPtr = malloc(RequiredSize);
 
@@ -421,7 +421,7 @@ void CFE_PSP_SetupReservedMemoryMap(void)
 
     /*
      * Set up the "RAM" entry in the memory table.
-     * On RTEMS this is just encompasses the entire memory space, but an entry needs
+     * On RTEMS this just encompasses the entire memory space, but an entry needs
      * to exist so that CFE_PSP_ValidateMemRange() works as intended.
      */
     CFE_PSP_MemRangeSet(0, CFE_PSP_MEM_RAM, 0, SIZE_MAX, CFE_PSP_MEM_SIZE_DWORD, CFE_PSP_MEM_ATTR_READWRITE);
@@ -480,7 +480,7 @@ int32 CFE_PSP_GetKernelTextSegmentInfo(cpuaddr *PtrToKernelSegment, uint32 *Size
         /*
         ** Get the kernel start and end
         ** addresses from the BSP, because the
-        ** symbol table does not contain the symbls we need for this
+        ** symbol table does not contain the symbols we need for this
         */
         StartAddress = (cpuaddr)0x0;
         EndAddress   = (cpuaddr)0x1024;
@@ -522,7 +522,7 @@ int32 CFE_PSP_GetCFETextSegmentInfo(cpuaddr *PtrToCFESegment, uint32 *SizeOfCFES
         /*
         ** Get the kernel start and end
         ** addresses from the BSP, because the
-        ** symbol table does not contain the symbls we need for this
+        ** symbol table does not contain the symbols we need for this
         */
         StartAddress = (cpuaddr)0x0;
         EndAddress   = (cpuaddr)0x1024;

fsw/pc-rtems/src/cfe_psp_ssr.c

@@ -24,7 +24,7 @@
 ** Purpose:
 **   This file contains glue routines between the cFE and the OS Board Support Package ( BSP ).
 **   The functions here allow the cFE to interface functions that are board and OS specific
-**   and usually dont fit well in the OS abstraction layer.
+**   and usually don't fit well in the OS abstraction layer.
 **
 ** History:
 **   2005/06/05  Alan Cudmore    | Initial version,

fsw/pc-rtems/src/cfe_psp_support.c

@@ -24,7 +24,7 @@
 ** Purpose:
 **   This file contains glue routines between the cFE and the OS Board Support Package ( BSP ).
 **   The functions here allow the cFE to interface functions that are board and OS specific
-**   and usually dont fit well in the OS abstraction layer.
+**   and usually don't fit well in the OS abstraction layer.
 **
 ** History:
 **   2005/06/05  Alan Cudmore    | Initial version,

fsw/pc-rtems/src/cfe_psp_watchdog.c

@@ -24,7 +24,7 @@
 ** Purpose:
 **   This file contains glue routines between the cFE and the OS Board Support Package ( BSP ).
 **   The functions here allow the cFE to interface functions that are board and OS specific
-**   and usually dont fit well in the OS abstraction layer.
+**   and usually don't fit well in the OS abstraction layer.
 **
 ** History:
 **   2009/07/20  A. Cudmore    | Initial version,

fsw/shared/inc/cfe_psp_module.h

@@ -41,7 +41,7 @@ typedef enum
 } CFE_PSP_ModuleType_t;
 
 /**
- * Protoype for a PSP module initialization function
+ * Prototype for a PSP module initialization function
  */
 typedef void (*CFE_PSP_ModuleInitFunc_t)(uint32 PspModuleId);
 
@@ -77,7 +77,7 @@ typedef const struct
  *
  * This function should only be called during PSP initialization before the
  * system is operational.  It is not intended to be called from application code after
- * CFE has started.  The function is not necessarily be thread-safe and should be called
+ * CFE has started.  The function is not necessarily thread-safe and should be called
  * before any child threads are created.
  *
  * Note that this does _not_ return any status --

fsw/shared/src/cfe_psp_memrange.c

@@ -205,7 +205,7 @@ uint32 CFE_PSP_MemRanges(void)
 ** Global Outputs: Changes CFE_PSP_MemoryTable
 **
 ** Return Values:
-**   CFE_PSP_SUCCESS -- Memory range set successfuly.
+**   CFE_PSP_SUCCESS -- Memory range set successfully.
 **   CFE_PSP_INVALID_MEM_RANGE -- The index into the table is invalid
 **   CFE_PSP_INVALID_MEM_ADDR -- Starting address is not valid
 **   CFE_PSP_INVALID_MEM_TYPE -- Memory type associated with the range does not match the passed in type.
@@ -262,7 +262,7 @@ int32 CFE_PSP_MemRangeSet(uint32 RangeNum, uint32 MemoryType, cpuaddr StartAddr,
 **		This function retrieves one of the records in the CFE_PSP_MemoryTable.
 **
 ** Assumptions and Notes:
-**    Becasue the table is fixed size, the entries are accessed by using the integer index.
+**    Because the table is fixed size, the entries are accessed by using the integer index.
 **
 ** Parameters:
 **    RangeNum --   A 32 bit integer ( starting with 0 ) specifying the MemoryTable entry.
@@ -272,7 +272,7 @@ int32 CFE_PSP_MemRangeSet(uint32 RangeNum, uint32 MemoryType, cpuaddr StartAddr,
 **                   is stored.
 **    *Size    --    A pointer to the 32 bit integer where the 32 bit size of the memory range
 **                   is stored.
-**    *WordSize --   A pointer to the 32 bit integer where the the minimum addressable size of the range:
+**    *WordSize --   A pointer to the 32 bit integer where the minimum addressable size of the range:
 **                     ( CFE_PSP_MEM_SIZE_BYTE, CFE_PSP_MEM_SIZE_WORD, CFE_PSP_MEM_SIZE_DWORD )
 **    Attributes -- The attributes of the Memory Range:
 **                     (CFE_PSP_MEM_ATTR_WRITE, CFE_PSP_MEM_ATTR_READ, CFE_PSP_MEM_ATTR_READWRITE)
@@ -282,7 +282,7 @@ int32 CFE_PSP_MemRangeSet(uint32 RangeNum, uint32 MemoryType, cpuaddr StartAddr,
 ** Global Outputs: Changes CFE_PSP_MemoryTable
 **
 ** Return Values:
-**   CFE_PSP_SUCCESS -- Memory range returned successfuly.
+**   CFE_PSP_SUCCESS -- Memory range returned successfully.
 **   CFE_PSP_INVALID_POINTER   -- Parameter error
 **   CFE_PSP_INVALID_MEM_RANGE -- The index into the table is invalid
 */