Skip to content

Commit

Permalink
Increase version to 5.0.8 and update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerardo E. Cruz-Ortiz committed Mar 12, 2020
1 parent 65a10d2 commit 2284a6f
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 25 deletions.
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ This distribution contains:

Version Notes:
==============
- 5.0.8: DEVELOPMENT
- Minor updates (see https://github.com/nasa/osal/pull/369)
- 5.0.7: DEVELOPMENT
- Fixes memset bug
- Minor updates (see https://github.com/nasa/osal/pull/361)
Expand Down Expand Up @@ -49,14 +51,14 @@ Getting Started:

See the document *doc/OSAL-Configuration-Guide.doc* for complete details.

An easy way to get started is to use the Linux port and classic build:
An easy way to get started is to use the Linux port and classic build:

1. Set the *OSAL_SRC* environment variable to point to the OSAL source code.
1. Set the *OSAL_SRC* environment variable to point to the OSAL source code.
- Running setvars.sh will set the variable for you ($source ./setvars.sh)
2. Edit the *build/osal-config.mak* file and set the following options:
- BSP - Set this to the board you are running on. For a PC running linux, use *pc-linux*
- BSP - Set this to the board you are running on. For a PC running linux, use *pc-linux*
- OS - Set this to the OS you are running. For a PC running linux, use *posix*.
- OSAL_M32 - Uncomment/Add this build variable for building 32-bit images using "native"
- OSAL_M32 - Uncomment/Add this build variable for building 32-bit images using "native"
GCC on a 64-bit X86 Linux platform

Buiding on a PC running linux:
Expand All @@ -67,11 +69,11 @@ In build/osal-config.mak:

OS=posix
BSP=pc-linux
Optional: OSAL_M32 = -m32 (Note: Usage of this flag may require an optional 'multilib' (or similar)
package to be installed. Refer to your operating system and toolchain documentation for details, if
adding the appropriate flag causes your builds to fail due to (for example) missing 32-bit or
multilib related headers or libraries.)

Optional: OSAL_M32 = -m32 (Note: Usage of this flag may require an optional 'multilib' (or similar)
package to be installed. Refer to your operating system and toolchain documentation for details, if
adding the appropriate flag causes your builds to fail due to (for example) missing 32-bit or
multilib related headers or libraries.)

Optional: Some Linux systems may require an additional linker option in
src/bsp/pc-linux/make/link-rules.mak:
Expand All @@ -81,17 +83,17 @@ Optional: Some Linux systems may require an additional linker option in
If the symbol-api-test fails, then you need this option.

Now just type *make config; make* from the build directory and it should build the OSAL core files, tests, and sample
applications for you. The binary for each application is in its own directory
(i.e. build/examples/tasking-example/tasking-example.bin) You can switch to that directory and run it. You
applications for you. The binary for each application is in its own directory
(i.e. build/examples/tasking-example/tasking-example.bin) You can switch to that directory and run it. You
can also debug it using GDB.

NOTE: Running on linux may require root or adjusting the posix message queue maximum sizes.
NOTE: Running on linux may require root or adjusting the posix message queue maximum sizes.

The Embedded targets take a little more work to run, because they must be cross compiled and booted on the board.
The Embedded targets take a little more work to run, because they must be cross compiled and booted on the board.
By copying a target, you should be able to come up with a new target.

If you would like just the OSAL itself, just look in src/os/inc for the include files and src/os/<your os here>
for the OSAL implementation.
If you would like just the OSAL itself, just look in src/os/inc for the include files and src/os/<your os here>
for the OSAL implementation.

The API documentation is in the *doc* directory.

Expand All @@ -101,7 +103,7 @@ perform the build steps above then *make unit-tests* in the build directory.
Instructions on how to use the newely supported cmake build system are provided in the OSAL Configuration Guide
located in the *doc* directory.

Contact Information:
Contact Information:
====================

Alan Cudmore
Expand All @@ -116,6 +118,6 @@ Copyright notice:
Copyright United States Government as represented by the Administrator of the National Aeronautics and Space Administration

License information:
====================
====================

This software is licensed under NASAs Open Source Agreement. The release of the software is conditional upon the recipients acceptance of the Open Source Agreement. Please see the file: NASA_Open_Source_Agreement_1_3-OS_AbstractionLayer.txt
16 changes: 8 additions & 8 deletions src/os/inc/osapi-version.h
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
/************************************************************************
** File: osapi-version.h
**
** Copyright (c) 2004-2006, United States government as represented by the
** administrator of the National Aeronautics Space Administration.
** All rights reserved. This software was created at NASAs Goddard
** Copyright (c) 2004-2006, United States government as represented by the
** administrator of the National Aeronautics Space Administration.
** All rights reserved. This software was created at NASAs Goddard
** Space Flight Center pursuant to government contracts.
**
** This is governed by the NASA Open Source Agreement and may be used,
** This is governed by the NASA Open Source Agreement and may be used,
** distributed and modified only pursuant to the terms of that agreement.
**
** Purpose:
** The OSAL version numbers
** Purpose:
** The OSAL version numbers
**
** Notes:
**
Expand All @@ -20,15 +20,15 @@

#define OS_MAJOR_VERSION 5
#define OS_MINOR_VERSION 0
#define OS_REVISION 7
#define OS_REVISION 8
#define OS_MISSION_REV 0

/**
* Combine the revision components into a single value that application code can check against
* e.g. "#if OSAL_API_VERSION >= 40100" would check if some feature added in OSAL 4.1 is present.
*/
#define OSAL_API_VERSION ((OS_MAJOR_VERSION * 10000) + (OS_MINOR_VERSION * 100) + OS_REVISION)

#endif /* _osapi_version_h_ */

/************************/
Expand Down

0 comments on commit 2284a6f

Please sign in to comment.