aboutsummaryrefslogtreecommitdiff
path: root/include/common.h
diff options
context:
space:
mode:
authorPaul Oliver <contact@pauloliver.dev>2024-02-29 02:29:14 +0100
committerPaul Oliver <contact@pauloliver.dev>2024-02-29 02:29:14 +0100
commit38764943e5fc61c424c018068dc7f6790dddf147 (patch)
tree65a0f5a00c91436b30e580f16365557437d61da7 /include/common.h
parent0e7b2e49585e3725736ae380cbd2dfb28fea5093 (diff)
Format repass.
Diffstat (limited to 'include/common.h')
-rw-r--r--include/common.h17
1 files changed, 13 insertions, 4 deletions
diff --git a/include/common.h b/include/common.h
index 50ac563..2db1258 100644
--- a/include/common.h
+++ b/include/common.h
@@ -12,24 +12,33 @@
#ifndef SALIS_COMMON_H
#define SALIS_COMMON_H
-/* Typedef sender functor type for easy python parsing.
+/**
+* Typedef sender functor type for easy python parsing.
*/
typedef void (*Sender)(uint8 inst);
-/* Typedef receiver functor type for easy python parsing.
+/**
+* Typedef receiver functor type for easy python parsing.
*/
typedef uint8 (*Receiver)(void);
-/* Set sender functor. When unset, SEND instruction does nothing.
+/**
+* Set sender functor. When unset, SEND instruction does nothing.
* @param sender Sender functor
*/
SALIS_API void sal_comm_set_sender(Sender sender);
-/* Set receiver functor. When unset, RCVE instruction does nothing.
+/**
+* Set receiver functor. When unset, RCVE instruction does nothing.
* @param receiver Receiver functor
*/
SALIS_API void sal_comm_set_receiver(Receiver receiver);
+
+/*******************************
+* PRIVATES *
+*******************************/
+
void _sal_comm_send(uint8 inst);
uint8 _sal_comm_receive(void);