fprime/Svc/Interfaces/Framer.fpp
Andrei Tumbar 5723115f5e
Add FPP Interfaces (#3709)
* Interfaces

* Point to new fpp alpha release

* Fix the fprime-gds version

* Update for framer/deframer work

* Fix cmake tests

* Clean up annotations

* Clean up final fpp
2025-06-24 09:08:44 -07:00

33 lines
1.5 KiB
Fortran

module Svc {
@ ----------------------------------------------------------------------
@ Framing
@ ----------------------------------------------------------------------
interface Framer {
@ Port to receive data to frame, in a Fw::Buffer with optional context
sync input port dataIn: Svc.ComDataWithContext
@ Port to output framed data with optional context
output port dataOut: Svc.ComDataWithContext
# ----------------------------------------------------------------------
# Data ownership
# ----------------------------------------------------------------------
@ Port for returning ownership of the incoming Fw::Buffer to its sender
@ once framing is handled
output port dataReturnOut: Svc.ComDataWithContext
@ Buffer coming from a deallocate call in a ComDriver component
sync input port dataReturnIn: Svc.ComDataWithContext
# ----------------------------------------------------------------------
# Handling of ready signals (ComQueue <-> ComInterface)
# ----------------------------------------------------------------------
@ Port receiving the general status from the downstream component
@ indicating it is ready or not-ready for more input
sync input port comStatusIn: Fw.SuccessCondition
@ Port receiving indicating the status of framer for receiving more data
output port comStatusOut: Fw.SuccessCondition
}
}