Document all functions in header files.

[apps/agl-service-can-low-level.git] / src / isotp / isotp.h

diff --git a/src/isotp/isotp.h b/src/isotp/isotp.h
index 923d592..3a3658c 100644 (file)
--- a/src/isotp/isotp.h
+++ b/src/isotp/isotp.h
@@ -1,59 +1,38 @@
 #ifndef __ISOTP_H__
 #define __ISOTP_H__
 
+#include <isotp/isotp_types.h>
+#include <isotp/send.h>
+#include <isotp/receive.h>
+#include <stdint.h>
+#include <stdbool.h>
+#include <stdio.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-struct {
-    uint16_t arb_id;
-    void* message_received_callback;
-    void* message_sent_callback;
-    void* can_frame_sent_callback;
-
-    // Private
-    uint16_t timeout_ms;
-    bool framePadding;
-    uint8_t* receive_buffer;
-    uint16_t received_buffer_size;
-    uint16_t incoming_message_size;
-    bool sending;
-    // TODO timer
-} IsoTpHandler;
-
-enum {
-    PCI_SINGLE,
-    PCI_FIRST_FRAME,
-    PCI_CONSECUTIVE_FRAME,
-    PCI_FLOW_CONTROL_FRAME
-} IsoTpProtocolControlInformation;
-
-enum {
-    PCI_FLOW_STATUS_CONTINUE,
-    PCI_FLOW_STATUS_WAIT,
-    PCI_FLOW_STATUS_OVERFLOW
-} IsoTpFlowStatus;
-
-const uint16_t MAX_ISO_TP_MESSAGE_SIZE = 4096;
-const uint16_t MAX_CAN_FRAME_SIZE = 8;
-const uint8_t ISO_TP_DEFAULT_RESPONSE_TIMEOUT = 100;
-const bool ISO_TP_DEFAULT_FRAME_PADDING_STATUS = true;
-
-IsoTpHandler isotp_init(uint16_t arbitration_id,
-        IsoTpMessageReceivedHandler* message_received_callback,
-        IsoTpMessageSentHandler* message_sent_callback,
-        IsoTpCanFrameSentHandler* can_frame_sent_callback);
-
-void isotp_set_timeout(uint16_t timeout);
-
-// TODO we have to make sure to copy the payload internall if it's more than 1
-// frame, the soure could go out of scope
-bool isotp_send(const uint8_t* payload, uint16_t payload_size);
-
-void isotp_receive_can_frame(const uint16_t arbitration_id, const uint8_t* data,
-        const uint8_t length);
-
-void isotp_destroy(IsoTpHandler* handler);
+/* Public: Initialize an IsoTpShims with the given callback functions.
+ *
+ * If any callbacks are not to be used, set them to NULL. For documentation of
+ * the function type signatures, see isotp_types.h. This struct is a handy
+ * encapsulation used to pass the shims around to the various isotp_* functions.
+ *
+ * Returns a struct with the fields initailized to the callbacks.
+ */
+IsoTpShims isotp_init_shims(LogShim log,
+        SendCanMessageShim send_can_message,
+        SetTimerShim set_timer);
+
+/* Public: Render an IsoTpMessage as a string into the given buffer.
+ *
+ * message - the message to convert to a string, for debug logging.
+ * destination - the target string buffer.
+ * destination_length - the size of the destination buffer, i.e. the max size
+ *      for the rendered string.
+ */
+void isotp_message_to_string(const IsoTpMessage* message, char* destination,
+        size_t destination_length);
 
 #ifdef __cplusplus
 }