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

Add assets to enable AIROC CYW43xx Bluetooth/Wi-Fi SoCs supports #7

Merged
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
1 change: 1 addition & 0 deletions abstraction-rtos/.cyignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs
165 changes: 165 additions & 0 deletions abstraction-rtos/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and
distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright
owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities
that control, are controlled by, or are under common control with that entity.
For the purposes of this definition, "control" means (i) the power, direct or
indirect, to cause the direction or management of such entity, whether by
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising
permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including
but not limited to software source code, documentation source, and configuration
files.

"Object" form shall mean any form resulting from mechanical transformation or
translation of a Source form, including but not limited to compiled object code,
generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made
available under the License, as indicated by a copyright notice that is included
in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that
is based on (or derived from) the Work and for which the editorial revisions,
annotations, elaborations, or other modifications represent, as a whole, an
original work of authorship. For the purposes of this License, Derivative Works
shall not include works that remain separable from, or merely link (or bind by
name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version
of the Work and any modifications or additions to that Work or Derivative Works
thereof, that is intentionally submitted to Licensor for inclusion in the Work
by the copyright owner or by an individual or Legal Entity authorized to submit
on behalf of the copyright owner. For the purposes of this definition,
"submitted" means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems, and
issue tracking systems that are managed by, or on behalf of, the Licensor for
the purpose of discussing and improving the Work, but excluding communication
that is conspicuously marked or otherwise designated in writing by the copyright
owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
of whom a Contribution has been received by Licensor and subsequently
incorporated within the Work.

2. Grant of Copyright License.

Subject to the terms and conditions of this License, each Contributor hereby
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
irrevocable copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the Work and such
Derivative Works in Source or Object form.

3. Grant of Patent License.

Subject to the terms and conditions of this License, each Contributor hereby
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
irrevocable (except as stated in this section) patent license to make, have
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
such license applies only to those patent claims licensable by such Contributor
that are necessarily infringed by their Contribution(s) alone or by combination
of their Contribution(s) with the Work to which such Contribution(s) was
submitted. If You institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
Contribution incorporated within the Work constitutes direct or contributory
patent infringement, then any patent licenses granted to You under this License
for that Work shall terminate as of the date such litigation is filed.

4. Redistribution.

You may reproduce and distribute copies of the Work or Derivative Works thereof
in any medium, with or without modifications, and in Source or Object form,
provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of
this License; and
You must cause any modified files to carry prominent notices stating that You
changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute,
all copyright, patent, trademark, and attribution notices from the Source form
of the Work, excluding those notices that do not pertain to any part of the
Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any
Derivative Works that You distribute must include a readable copy of the
attribution notices contained within such NOTICE file, excluding those notices
that do not pertain to any part of the Derivative Works, in at least one of the
following places: within a NOTICE text file distributed as part of the
Derivative Works; within the Source form or documentation, if provided along
with the Derivative Works; or, within a display generated by the Derivative
Works, if and wherever such third-party notices normally appear. The contents of
the NOTICE file are for informational purposes only and do not modify the
License. You may add Your own attribution notices within Derivative Works that
You distribute, alongside or as an addendum to the NOTICE text from the Work,
provided that such additional attribution notices cannot be construed as
modifying the License.
You may add Your own copyright statement to Your modifications and may provide
additional or different license terms and conditions for use, reproduction, or
distribution of Your modifications, or for any such Derivative Works as a whole,
provided Your use, reproduction, and distribution of the Work otherwise complies
with the conditions stated in this License.

5. Submission of Contributions.

Unless You explicitly state otherwise, any Contribution intentionally submitted
for inclusion in the Work by You to the Licensor shall be under the terms and
conditions of this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify the terms of
any separate license agreement you may have executed with Licensor regarding
such Contributions.

6. Trademarks.

This License does not grant permission to use the trade names, trademarks,
service marks, or product names of the Licensor, except as required for
reasonable and customary use in describing the origin of the Work and
reproducing the content of the NOTICE file.

7. Disclaimer of Warranty.

Unless required by applicable law or agreed to in writing, Licensor provides the
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
including, without limitation, any warranties or conditions of TITLE,
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
solely responsible for determining the appropriateness of using or
redistributing the Work and assume any risks associated with Your exercise of
permissions under this License.

8. Limitation of Liability.

In no event and under no legal theory, whether in tort (including negligence),
contract, or otherwise, unless required by applicable law (such as deliberate
and grossly negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special, incidental,
or consequential damages of any character arising as a result of this License or
out of the use or inability to use the Work (including but not limited to
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
any and all other commercial damages or losses), even if such Contributor has
been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability.

While redistributing the Work or Derivative Works thereof, You may choose to
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
other liability obligations and/or rights consistent with this License. However,
in accepting such obligations, You may act only on Your own behalf and on Your
sole responsibility, not on behalf of any other Contributor, and only if You
agree to indemnify, defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason of your
accepting any such warranty or additional liability.
111 changes: 111 additions & 0 deletions abstraction-rtos/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# RTOS Abstraction

## Overview

The RTOS abstraction layer provides simple RTOS services like threads, semaphores, mutexes, queues, and timers. It is not intended to be a full features RTOS interface, but the provide just enough support to allow for RTOS independent drivers and middleware. This allows middleware applications to be as portable as possible within ModusToolbox™. This library provides a unified API around the actual RTOS. This allows middleware libraries to be written once independent of the RTOS actually selected for the application. The abstraction layer provides access to all the standard RTOS resources listed in the feature section below.

While the primary purpose of the library is for middleware, the abstraction layer can be used by the application code. However, since this API does not provide all RTOS features and the application generally knows what RTOS is being used, this is typically an unnecessary overhead.

All the RTOS abstraction layer functions generally all work the same way. The basic process is:
1. Include the cyabs_rtos.h header file so that you have access to the RTOS functions.
2. Declare a variable of the right type (e.g. cy_mutex_t)
3. Call the appropriate create or initialize function (e.g. cy_rtos_init_mutex()). Provide it with a reference to the variable that was created in step 2.
4. Access the RTOS object using one of the access functions. e.g. cy_rtos_set_mutex().
5. If you don't need it anymore, free up the pointer with the appropriate de-init function (e.g. cy_rtos_deinit_mutex()).

NOTE: All these functions need a pointer, so it is generally best to declare these "shared" resources as static global variables within the file that they are used.

## Getting Started

To use the RTOS Abstraction, simply include a reference to `cyabs_rtos.h` and update the application's makefile to include the appropriate component. e.g. one of:
* COMPONENTS+=RTX
* COMPONENTS+=FREERTOS
* COMPONENTS+=THREADX

## Features

* APIs for interacting with common RTOS Features including:
* Threads
* Mutexes
* Semaphores
* Timers
* Queues
* Events
* Implementations are provided for
* FreeRTOS
* RTX (CMSIS RTOS)
* ThreadX

## RTOS Configuration Requirements
### FreeRTOS
To enable all functionality when using with FreeRTOS, the following configuration options must be enabled in FreeRTOSConfig.h:
* configSUPPORT_DYNAMIC_ALLOCATION
* configSUPPORT_STATIC_ALLOCATION
* configUSE_COUNTING_SEMAPHORES
* configUSE_MUTEXES
* configUSE_NEWLIB_REENTRANT
* configUSE_RECURSIVE_MUTEXES
* configUSE_TASK_NOTIFICATIONS
* configUSE_TICKLESS_IDLE
* configUSE_TIMERS
* configUSE_TRACE_FACILITY

* INCLUDE_vTaskDelay
* INCLUDE_vTaskDelete
* INCLUDE_vTaskPrioritySet
* INCLUDE_uxTaskPriorityGet
* INCLUDE_xTimerPendFunctionCall
* INCLUDE_vTaskSuspend

Enabling configSUPPORT_STATIC_ALLOCATION requires the application to provide implementations for `vApplicationGetIdleTaskMemory` and
`vApplicationGetTimerTaskMemory`functions. Weak implementations for these functions are provided as a part of this library. These can
be overridden by the application if custom implementations of these functions are desired.<br>

This library provides an API `vApplicationSleep` which can be used to enable tickless support in FreeRTOS. In order to enable tickless mode with this API, the following changes need to be made in `FreeRTOSConfig.h`:
* Enables tickless mode with user specified `portSUPPRESS_TICKS_AND_SLEEP` implementation.<br>
\c \#define `configUSE_TICKLESS_IDLE 2`
* Hook `portSUPPRESS_TICKS_AND_SLEEP` macro to `vApplicationSleep` implementation.<br>
\c \#define `portSUPPRESS_TICKS_AND_SLEEP( xIdleTime ) vApplicationSleep( xIdleTime )`

For further details on Low power support in FreeRTOS please refer to documentation [here](https://www.freertos.org/low-power-tickless-rtos.html)

### RTX / ThreadX
No specific requirements exist

## Porting Notes
In order to port to a new environment, the file cyabs_rtos_impl.h must be provided with definitions of some basic types for the abstraction layer. The types expected to be defined are:

- `cy_thread_t` : typedef from underlying RTOS thread type
- `cy_thread_arg_t` : typedef from the RTOS type that is passed to the entry function of a thread.
- `cy_mutex_t` : typedef from the underlying RTOS mutex type
- `cy_semaphore_t`: typedef from the underlying RTOS semaphore type
- `cy_event_t` : typedef from the underlying RTOS event type
- `cy_queue_t` : typedef from the underlying RTOS queue type
- `cy_timer_callback_arg_t` : typedef from the RTOS type that is passed to the timer callback function
- `cy_timer_t` : typedef from the underlying RTOS timer type
- `cy_time_t` : count of time in milliseconds
- `cy_rtos_error_t` : typedef from the underlying RTOS error type

The enum `cy_thread_priority_t` needs to have the following priority values defined and mapped to RTOS specific values:
- `CY_RTOS_PRIORITY_MIN`
- `CY_RTOS_PRIORITY_LOW`
- `CY_RTOS_PRIORITY_BELOWNORMAL`
- `CY_RTOS_PRIORITY_NORMAL`
- `CY_RTOS_PRIORITY_ABOVENORMAL`
- `CY_RTOS_PRIORITY_HIGH`
- `CY_RTOS_PRIORITY_REALTIME`
- `CY_RTOS_PRIORITY_MAX`

Finally, the following macros need to be defined for memory allocations:
- `CY_RTOS_MIN_STACK_SIZE`
- `CY_RTOS_ALIGNMENT`
- `CY_RTOS_ALIGNMENT_MASK`

## More information
* [API Reference Guide](https://infineon.github.io/abstraction-rtos/html/modules.html)
* [Cypress Semiconductor, an Infineon Technologies Company](http://www.cypress.com)
* [Infineon GitHub](https://github.com/infineon)
* [ModusToolbox™](https://www.cypress.com/products/modustoolbox-software-environment)

---
© Cypress Semiconductor Corporation (an Infineon company) or an affiliate of Cypress Semiconductor Corporation, 2019-2021.
73 changes: 73 additions & 0 deletions abstraction-rtos/RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# RTOS Abstraction Library
The RTOS Abstraction APIs allow middleware to be written to be RTOS aware, but not need to care about what the actual RTOS is.

### What's Included?
The this release of the RTOS Abstraction API includes support for the following:
* APIs for interacting with common RTOS Features including:
* Threads
* Mutexes
* Semaphores
* Timers
* Queues
* Events
* Implementations are provided for
* FreeRTOS
* RTX (CMSIS RTOS)
* ThreadX

### What Changed?
#### v1.5.0
* Added additional parameter validation for ThreadX
#### v1.4.0
* Added new thread functions: cy_rtos_wait_thread_notification and cy_rtos_set_thread_notification
* Minor documentation updates for clarity
#### v1.3.1
* Fixed a couple bugs in the FreeRTOS port
#### v1.3.0
* Update to work with a wider range of MCUs
* Fixed a race condition in the worker thread
* Fixed possible issue with thread priorities
* Minor documentation updates
#### v1.2.2
* Minor update for documentation & branding
#### v1.2.1
* Fixed possible race condition in cy_rtos_join_thread for FreeRTOS
* Minor documentation updates
#### v1.2.0
* Added utility library for for creating background worker threads: cy_worker_thread.h
* Added support for getting a semaphore's count: cy_rtos_get_count_semaphore()
* Added support for non-recursive mutexes: cy_rtos_init_mutex2()
* Added default implementations for FreeRTOS vApplicationGetIdleTaskMemory, vApplicationGetTimerTaskMemory, and vApplicationSleep
* Added support for ThreadX
NOTE: The vApplicationSleep implementation for FreeRTOS depends on the psoc6hal 1.2.0 or later.
#### v1.1.0
* Fixed an issue with the FreeRTOS implementation where it would always allocate memory for the thread stack, even if a pre-allocated buffer was provided.
* Removed usage of assert() and replaced with CY_ASSERT()
#### v1.0.1
* Added a new function to get the ID of the currently running thread.
* A few minor updates to avoid possible warnings depending on compiler.
* Minor documentation updates
#### v1.0.0
* Initial release supporting FreeRTOS & RTX

### Supported Software and Tools
This version of the RTOS Abstraction API was validated for compatibility with the following Software and Tools:

| Software and Tools | Version |
| :--- | :----: |
| ModusToolbox™ Software Environment | 2.4.0 |
| GCC Compiler | 10.3.1 |
| IAR Compiler | 8.4 |
| ARM Compiler | 6.11 |

Minimum required ModusToolbox™ Software Environment: v2.0

### More information
Use the following links for more information, as needed:
* [API Reference Guide](https://infineon.github.io/abstraction-rtos/html/modules.html)
* [Cypress Semiconductor, an Infineon Technologies Company](http://www.cypress.com)
* [Infineon GitHub](https://github.com/infineon)
* [ModusToolbox™](https://www.cypress.com/products/modustoolbox-software-environment)

---
© Cypress Semiconductor Corporation (an Infineon company) or an affiliate of Cypress Semiconductor Corporation, 2019-2021.
Loading