summaryrefslogtreecommitdiffstats
path: root/images/c_user/regulator_input_sequence.puml
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2023-07-18 15:28:20 -0500
committerJoel Sherrill <joel@rtems.org>2023-08-09 10:40:56 -0500
commit7bd117cb00b68e5cb89aa8c237a813730876817e (patch)
treeacb0bab9398635e363f712afe39d06b09b77f4fb /images/c_user/regulator_input_sequence.puml
parenteng: add Apache License 2.0 restriction (diff)
downloadrtems-docs-7bd117cb00b68e5cb89aa8c237a813730876817e.tar.bz2
Add Regulator documentation based on V1 functionality
Diffstat (limited to '')
-rw-r--r--images/c_user/regulator_input_sequence.puml16
1 files changed, 16 insertions, 0 deletions
diff --git a/images/c_user/regulator_input_sequence.puml b/images/c_user/regulator_input_sequence.puml
new file mode 100644
index 0000000..aa9020c
--- /dev/null
+++ b/images/c_user/regulator_input_sequence.puml
@@ -0,0 +1,16 @@
+' SPDX-License-Identifier: CC-BY-SA-4.0
+
+' Copyright (C) 2023 OAR Corporatoin
+
+@startuml "Regulator Application Input Source Usage"
+ Source -> Regulator : rtems_regulator_obtain_buffer(regulator, buffer)
+ Regulator -> RTEMS : rtems_partition_get_buffer(id, buffer)
+ RTEMS --> Regulator : rtems_status_code
+ Regulator --> Source : rtems_status_code
+ Source -> Regulator : rtems_regulator_send(regulator, message, length)
+ Regulator -> RTEMS : rtems_message_queue_send(id, message, size)
+ RTEMS --> Regulator : rtems_status_code
+ Regulator --> Source : rtems_status_code
+
+@enduml
+