Module Overviews

You can find a list of Module Overviews on the following pages:

• Framework Layer
• HAL Layer
• Azure RTOS Modules

The Module Overviews for each SSP module have been significantly improved since the last release. The new Module Overviews should provide all the information necessary for a developer to evaluate a specific modules fitness for use in a target application and significantly help with the development process. The intent of these notes is to provide all the information needed to begin develop0ment with the target module in one easy to find location.

Each Module Overview includes the following sections:

1. A short introduction to the module includes a short description, a block diagram of key module components, and a list of features
2. An API table lists all the available APIs, and example use of the API and a short description of the APIs function. A list of some of the key Status Return values is provided to help determine the result of the API call.
3. A functional overview describes key module operations and includes a list of important module limitations.
4. A step-by-step description of how to include the module in an application using the ISDE threads tab and stack selection process.
5. A set of tables showing the configuration parameters for the module and key lower level modules is provided so the developer can easily see the modules key capabilities. Note that these configurable properties vary by MCU series and by SSP Release. Treat the tables in these notes as illustrations and refer to the actual parameters available within the ISDE for your target MCU and for your chosen SSP release. Example pin and clock configuration and selection information is also provided to help guide development.
6. A simple implementation using the target module is provided and shows the steps used in a typical application, the associated flow diagram, and the API use at each step. This helps describe how APIs are commonly used and will give the developer a head start with their implementation.

Module Guide Application Notes

These six sections are also found in the Module Guide Application Notes for a specific module. In the Application Note additional sections provide detailed descriptions of the associated application project that demonstrates the module working in an actual design. Development can be dramatically simplified when the application project is used as a starting point or reference for a new design. Module guide application notes can be found with the following search: https://www.renesas.com/us/en/support/document-search?doc_file_all_types%5BApplication+Note%5D=Application+Note&doc_file_all_types%5BSample+Code+-+FIT+Module%5D=Sample+Code+-+FIT+Module&doc_file_all_types%5BSample+Code%5D=Sample+Code&doc_category_tier_1=467666&doc_category_tier_2=469306&doc_part_numbers=&keywords=&sort_order=DESC&sort_by=field_document_revision_date#documentation-tools-results. More module guide application notes are being added all the time so check back frequently to find when new ones have been released.

Using the Module Guide Module Overviews

The Module Overviews provide sufficient details to begin development, but there will be cases when additional information is useful in implementing a design. The SSP User Manual provides a wealth of information on the details of API implementation, structures, enumerations and more. Simply jump to the API reference section and find your module of interest to find any additional information you might need.

HAL modules have chapters that cover the above topics as well. It is highly recommended that you spend some time looking at the reference material available in ALL the reference chapters so you know where to look when an API implementation question, not answered in the module guide usage note or associated module guide application note, comes up.