Information on the module guide itself and the associated resources and known issues are available here.
The Messaging Framework module is implemented on sf_message and includes a lightweight and event-driven framework API for passing messages between threads. The Messaging Framework module allows applications to communicate messages between two or more threads. The framework uses the ThreadX message-queue primitive for message passing and provides more benefits than the ThreadX RTOS message-queue services alone. The Messaging Framework API is purely a software API and does not access any hardware peripherals. The Messaging Framework callback is used to allow an event-producer thread and a message-subscriber thread to handshake after the message passing is done.
You can use the messaging tab to either create your own custom event classes, events, and subscribers for the Messaging Framework module or to customize preconfigured events such as the touch event used by the Touch Panel Framework module.
The Messaging Framework module supports the following features:
- Inter-Thread Communication - The framework allows application threads which control disparate devices or manage subsystems to communicate with each other.
- Publishing/Subscribe scheme - The framework design is based on the loosely-coupled messaging paradigm. The design allows multiple threads to listen to an event class. The message producer thread does not need to know who is subscribing to a message for the event class. Subscribers do not need to know who produces the message.
- Message management - The framework supports buffer control blocks to manage each message including flags to control the buffer and a callback function pointer for handshaking.
- Message buffering - The framework manages buffer allocation and release for messaging. An application can make use of the allocated buffer to write a message and discard the message if it is no longer needed.
- Synchronous communication - The framework supports asynchronous messaging by using the ThreadX message-queue but also provides an option to create a handshake between a message producer and a subscriber thread. The handshake is implemented by invoking a user-callback function of the producer thread from a subscriber thread.
- Message formatting - The framework provides a predefined common message header. It also provides some typical payload structure templates as examples.
- Message Priority - The framework can send a high-priority message so that a subscriber thread can retrieve the message prior to other messages which are located in the message queue.
The Messaging Framework module guide is targeted for SSP 1.2.0 and above and the SK-S7G2 Kit.
The most recent versions of the Messaging Framework module guide application note, application project and import guide are available here.
Module Guide Resources
- Renesas Synergy™ Project DK-S124 Simple Record/Playback here.
- Renesas Synergy™ Project DK-S124 Simple Tone Generator here.
- Getting Started with the Audio Player Video here.
- The Messaging Framework Configurator Video here.
- Refer to the SSP release notes for current known issues, available here
|SSP 1.2.0 and above|